ContentItem
in package
This is a general purpose ContentItem class with no Tsugi-specific dependencies.
Deep Linking 1.0 / Content Item Spec
https://www.imsglobal.org/specs/lticiv1p0/specification
Table of Contents
Properties
- $json : mixed
Methods
- __construct() : mixed
- 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 Content Item
- 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
- allowMultiple() : mixed
- allowMultiple - Returns true if we can return LTI Link Items
- getContentItemSelection() : mixed
- Return the parameters to send back to the LMS
- returnUrl() : string
- returnUrl - Returns the content_item_return_url
Properties
$json
public
mixed
$json
Methods
__construct()
public
__construct() : 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 Content Item
public
addLtiLinkItem(mixed $url[, mixed $title = false ][, mixed $text = false ][, mixed $icon = false ][, mixed $fa_icon = false ][, mixed $custom = false ][, mixed $points = false ][, mixed $activityId = 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
- $points : mixed = false
-
The number of points if this is an assignment
- $activityId : mixed = false
-
The activity for the item
- $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
static allowContentItem(mixed $postdata) : mixed
Parameters
- $postdata : mixed
allowImportItem()
allowImportItem - Returns true if we can return IMS Common Cartridges
public
static allowImportItem(mixed $postdata) : mixed
Parameters
- $postdata : mixed
allowLink()
allowLink - Returns true if we can return HTML Items
public
static allowLink(mixed $postdata) : mixed
Upwards compatibility with DeepLink 2.0
Parameters
- $postdata : mixed
allowLtiLinkItem()
allowLtiLinkItem - Returns true if we can return LTI Link Items
public
static allowLtiLinkItem(mixed $postdata) : mixed
Parameters
- $postdata : mixed
allowMultiple()
allowMultiple - Returns true if we can return LTI Link Items
public
static allowMultiple(mixed $postdata) : mixed
Parameters
- $postdata : mixed
getContentItemSelection()
Return the parameters to send back to the LMS
public
getContentItemSelection([mixed $data = false ]) : mixed
Parameters
- $data : mixed = false
returnUrl()
returnUrl - Returns the content_item_return_url
public
static returnUrl(mixed $postdata) : string
Parameters
- $postdata : mixed
Return values
string —The content_item_return_url or false