1. class
  2. Tsugi
  3. \
  4. Util
  5. \
  6. DeepLinkRequest

DeepLinkRequest

class DeepLinkRequest

This is a general purpose DeepLinkRequest class

https://www.imsglobal.org/spec/lti-dl/v2p0

Properties

$claim

Methods

__construct($claim)

No description

string
returnUrl()

returnUrl - Returns the deep_link_return_url

allowMimetype($Mimetype)

allowMimetype - Returns true if we can return LTI Link Items

allowMultiple()

allowMultiple - Returns true if we can return multiple items

acceptType($type)

acceptType - Returns true if the string is in the accept_types

allowLtiLinkItem()

allowLtiLinkItem - Returns true if we can return LTI Link Items "accept_types": ["link", "file", "html", "ltiResourceLink", "image"],

allowContentItem()

allowContentItem - Returns true if we can return HTML Items

allowLink()

allowLink - Returns true if we can return HTML Items

allowImportItem()

allowImportItem - Returns true if we can return IMS Common Cartridges

getClaim(str $string, default $default = null)

getClaim - get a extension claim

Details

at line 29
__construct($claim)

Parameters

$claim

at line 39
string returnUrl()

returnUrl - Returns the deep_link_return_url

Return Value

string The deep_link_return_url or false

at line 47
allowMimetype($Mimetype)

allowMimetype - Returns true if we can return LTI Link Items

Parameters

$Mimetype

at line 63
allowMultiple()

allowMultiple - Returns true if we can return multiple items

at line 77
acceptType($type)

acceptType - Returns true if the string is in the accept_types

"accept_types": ["link", "file", "html", "ltiResourceLink", "image"],

Parameters

$type

at line 87
allowLtiLinkItem()

allowLtiLinkItem - Returns true if we can return LTI Link Items "accept_types": ["link", "file", "html", "ltiResourceLink", "image"],

at line 95
allowContentItem()

allowContentItem - Returns true if we can return HTML Items

allowLink - Returns true if we can return HTML Items

at line 112
allowImportItem()

allowImportItem - Returns true if we can return IMS Common Cartridges

at line 131
getClaim(str $string, default $default = null)

getClaim - get a extension claim

Parameters

str $string The claim to retrieve
default $default The default value