1. class
  2. Tsugi
  3. \
  4. Core
  5. \
  6. ContentItem

ContentItem

class ContentItem extends ContentItem

This is a ContentItem class with Tsugi-specific convienences.

Properties

$json from ContentItem

Methods

__construct()

No description

from ContentItem
static string
returnUrl($postdata = false)

returnUrl - Returns the content_item_return_url

static 
allowMultiple($postdata = false)

allowMultiple - Returns true if we can return multiple items

static 
allowLtiLinkItem($postdata = false)

allowLtiLinkItem - Returns true if we can return LTI Link Items

static 
allowLink($postdata = false)

allowLink - Returns true if we can return URLs

static 
allowContentItem($postdata = false)

allowContentItem - Returns true if we can return HTML Items

static 
allowImportItem($postdata = false)

allowImportItem - Returns true if we can return Common Cartridges

getContentItemSelection($data = false)

Return the parameters to send back to the LMS

addLtiLinkItem($url, $title = false, $text = false, $icon = false, $fa_icon = false, $custom = false, $points = false, $activityId = false, $additionalParams = array())

addLtiLinkItem - Add an LTI Link Content Item

from ContentItem
addLtiLinkItemExtended($params = array())

addLtiLinkItemExtended - Add an LTI Link Content Item

from ContentItem
addContentItem($url, $title = false, $text = false, $icon = false, $fa_icon = false, $additionalParams = array())

addContentItem - Add an Content Item

from ContentItem
addContentItemExtended($params = array())

addContentItemExtended - Add an Content Item

from ContentItem
addFileItem($url, $title = false, $additionalParams = array())

addFileItem - Add an File Item

from ContentItem
prepareResponse($endform = false, $debug = false, $iframeattr = false)

Make up a response

Details

in ContentItem at line 17
__construct()

at line 19
static string returnUrl($postdata = false)

returnUrl - Returns the content_item_return_url

Parameters

$postdata

Return Value

string The content_item_return_url or false

at line 27
static allowMultiple($postdata = false)

allowMultiple - Returns true if we can return multiple items

Parameters

$postdata

at line 35
static allowLtiLinkItem($postdata = false)

allowLtiLinkItem - Returns true if we can return LTI Link Items

Parameters

$postdata

allowLink - Returns true if we can return URLs

Parameters

$postdata

at line 52
static allowContentItem($postdata = false)

allowContentItem - Returns true if we can return HTML Items

Parameters

$postdata

at line 60
static allowImportItem($postdata = false)

allowImportItem - Returns true if we can return Common Cartridges

Parameters

$postdata

at line 68
getContentItemSelection($data = false)

Return the parameters to send back to the LMS

Parameters

$data

in ContentItem at line 145
addLtiLinkItem($url, $title = false, $text = false, $icon = false, $fa_icon = false, $custom = false, $points = false, $activityId = false, $additionalParams = array())

addLtiLinkItem - Add an LTI Link Content Item

Parameters

$url
$title
$text
$icon
$fa_icon
$custom
$points
$activityId
$additionalParams

in ContentItem at line 174
addLtiLinkItemExtended($params = array())

addLtiLinkItemExtended - Add an LTI Link Content Item

Parameters

$params Key/Value pair of configurable options for content item (see addLtiLinkItem)

in ContentItem at line 277
addContentItem($url, $title = false, $text = false, $icon = false, $fa_icon = false, $additionalParams = array())

addContentItem - Add an Content Item

Parameters

$url
$title
$text
$icon
$fa_icon
$additionalParams

in ContentItem at line 305
addContentItemExtended($params = array())

addContentItemExtended - Add an Content Item

Parameters

$params Key/Value pair of configurable options for content item (see addContentItem)

in ContentItem at line 373
addFileItem($url, $title = false, $additionalParams = array())

addFileItem - Add an File Item

Parameters

$url
$title
$additionalParams

at line 84
prepareResponse($endform = false, $debug = false, $iframeattr = false)

Make up a response

Parameters

$endform Some HTML to be included before the form closing tag

$endform = '<a href="index.php" class="btn btn-warning">Back to Store</a>';
$debug boolean true to pause process to debug.
$iframeattr A string of attributes to put on the iframe tag