Class to represent a content-item object. More...

Inheritance diagram for Item:

Public Member Functions
	__construct ($type, $placementAdvices=null, $id=null)
	Class constructor.

	setUrl ($url)
	Set a URL value for the content-item.

	setMediaType ($mediaType)
	Set a media type value for the content-item.

	setTitle ($title)
	Set a title value for the content-item.

	setText ($text)
	Set a link text value for the content-item.

	setHtml ($html)
	Set an HTML embed value for the content-item.

	addPlacementAdvice ($placementAdvice)
	Add a placement for the content-item.

	setIcon ($icon)
	Set an icon image for the content-item.

	setThumbnail ($thumbnail)
	Set a thumbnail image for the content-item.

	setHideOnCreate ($hideOnCreate)
	Set whether the content-item should be hidden from learners by default.

Static Public Member Functions
static	toJson ($items, $ltiVersion=Util::LTI_VERSION1)
	Wrap the content items to form a complete application/vnd.ims.lti.v1.contentitems+json media type instance.

static	fromJson ($items)
	Generate an array of Item objects from their JSON representation.

static	fromJsonItem ($item)
	Generate an Item object from its JSON or JSON-LD representation.

Data Fields
const	TYPE_LINK = 'link'
	Type for link content-item.

const	TYPE_LTI_LINK = 'ltiResourceLink'
	Type for LTI link content-item.

const	TYPE_LTI_ASSIGNMENT = 'ltiAssignment'
	Type for LTI assignment content-item.

const	TYPE_FILE = 'file'
	Type for file content-item.

const	TYPE_HTML = 'html'
	Type for HTML content-item.

const	TYPE_IMAGE = 'image'
	Type for image content-item.

const	LTI_LINK_MEDIA_TYPE = 'application/vnd.ims.lti.v1.ltilink'
	Media type for LTI launch links.

const	LTI_ASSIGNMENT_MEDIA_TYPE = 'application/vnd.ims.lti.v1.ltiassignment'
	Media type for LTI assignment links.

Protected Member Functions
	toJsonldObject ()
	Wrap the content item to form an item complying with the application/vnd.ims.lti.v1.contentitems+json media type.

	toJsonObject ()
	Wrap the content items to form a complete value for the https://purl.imsglobal.org/spec/lti-dl/claim/content_items claim.

	fromJsonObject ($item)
	Extract content-item details from its JSON representation.

Detailed Description

Class to represent a content-item object.

Author: Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright: SPV Software Products

Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 14 of file Content/Item.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$type,
		$placementAdvices = `null`,
		$id = `null`
	)

Class constructor.

Parameters

string	$type	Class type of content-item
Placement[] \| Placement \| null	$placementAdvices	Array of Placement objects (or single placement object) for item (optional)
string \| null	$id	URL of content-item (optional)

Reimplemented in ContentItem.

Definition at line 141 of file Content/Item.php.

Referenced by LtiAssignmentItem\__construct().

Member Function Documentation

◆ addPlacementAdvice()

addPlacementAdvice ( $placementAdvice )

Add a placement for the content-item.

Parameters

Placement | null $placementAdvice Placement advice object

Definition at line 210 of file Content/Item.php.

◆ fromJson()

static fromJson ( $items )

static

Generate an array of Item objects from their JSON representation.

Parameters

object $items A JSON object representing Content-Items

Returns: array Array of Item objects

Definition at line 284 of file Content/Item.php.

◆ fromJsonItem()

static fromJsonItem ( $item )

static

Generate an Item object from its JSON or JSON-LD representation.

Parameters

object $item A JSON or JSON-LD object representing a content-item

Returns: Item|LtiLinkItem|FileItem The content-item object

Definition at line 448 of file Content/Item.php.

◆ fromJsonObject()

fromJsonObject ( $item )

protected

Extract content-item details from its JSON representation.

Parameters

object $item A JSON object representing a content-item

Reimplemented in FileItem, and LtiLinkItem.

Definition at line 510 of file Content/Item.php.

◆ setHideOnCreate()

setHideOnCreate ( $hideOnCreate )

Set whether the content-item should be hidden from learners by default.

Parameters

bool | null $hideOnCreate True if the item should be hidden from learners

Definition at line 242 of file Content/Item.php.

◆ setHtml()

setHtml ( $html )

Set an HTML embed value for the content-item.

Parameters

string | null $html HTML text value

Definition at line 200 of file Content/Item.php.

◆ setIcon()

setIcon ( $icon )

Set an icon image for the content-item.

Parameters

Image | null $icon Icon image object

Definition at line 222 of file Content/Item.php.

◆ setMediaType()

setMediaType ( $mediaType )

Set a media type value for the content-item.

Parameters

string | null $mediaType Media type value

Definition at line 170 of file Content/Item.php.

Referenced by LtiAssignmentItem\__construct(), and LtiLinkItem\__construct().

◆ setText()

setText ( $text )

Set a link text value for the content-item.

Parameters

string | null $text Link text value

Definition at line 190 of file Content/Item.php.

◆ setThumbnail()

setThumbnail ( $thumbnail )

Set a thumbnail image for the content-item.

Parameters

Image | null $thumbnail Thumbnail image object

Definition at line 232 of file Content/Item.php.

◆ setTitle()

setTitle ( $title )

Set a title value for the content-item.

Parameters

string | null $title Title value

Definition at line 180 of file Content/Item.php.

◆ setUrl()

setUrl ( $url )

Set a URL value for the content-item.

Parameters

string | null $url URL value

Definition at line 160 of file Content/Item.php.

◆ toJson()

static toJson	(	$items,
		$ltiVersion = `Util::LTI_VERSION1`
	)

static

Wrap the content items to form a complete application/vnd.ims.lti.v1.contentitems+json media type instance.

Parameters

Item[] \| Item	$items	An array of content items or a single item
string	$ltiVersion	LTI version in use

Returns: string

Definition at line 255 of file Content/Item.php.

References Util\LTI_VERSION1P3.

◆ toJsonldObject()

toJsonldObject ( )

protected

Wrap the content item to form an item complying with the application/vnd.ims.lti.v1.contentitems+json media type.

Returns: object JSON object

Reimplemented in FileItem, and LtiLinkItem.

Definition at line 309 of file Content/Item.php.

◆ toJsonObject()

toJsonObject ( )

protected

Wrap the content items to form a complete value for the https://purl.imsglobal.org/spec/lti-dl/claim/content_items claim.

Returns: object JSON object

Reimplemented in FileItem, and LtiLinkItem.

Definition at line 377 of file Content/Item.php.

Field Documentation

◆ LTI_ASSIGNMENT_MEDIA_TYPE

const LTI_ASSIGNMENT_MEDIA_TYPE = 'application/vnd.ims.lti.v1.ltiassignment'

Media type for LTI assignment links.

Definition at line 55 of file Content/Item.php.

Referenced by LtiAssignmentItem\__construct().

◆ LTI_LINK_MEDIA_TYPE

const LTI_LINK_MEDIA_TYPE = 'application/vnd.ims.lti.v1.ltilink'

Media type for LTI launch links.

Definition at line 50 of file Content/Item.php.

Referenced by LtiLinkItem\__construct().

◆ TYPE_FILE

const TYPE_FILE = 'file'

Type for file content-item.

Definition at line 35 of file Content/Item.php.

Referenced by FileItem\__construct().

◆ TYPE_HTML

const TYPE_HTML = 'html'

Type for HTML content-item.

Definition at line 40 of file Content/Item.php.

◆ TYPE_IMAGE

const TYPE_IMAGE = 'image'

Type for image content-item.

Definition at line 45 of file Content/Item.php.

◆ TYPE_LINK

const TYPE_LINK = 'link'

Type for link content-item.

Definition at line 20 of file Content/Item.php.

◆ TYPE_LTI_ASSIGNMENT

const TYPE_LTI_ASSIGNMENT = 'ltiAssignment'

Type for LTI assignment content-item.

Definition at line 30 of file Content/Item.php.

Referenced by LtiAssignmentItem\__construct().

◆ TYPE_LTI_LINK

const TYPE_LTI_LINK = 'ltiResourceLink'

Type for LTI link content-item.

Definition at line 25 of file Content/Item.php.

Referenced by LtiLinkItem\__construct().

The documentation for this class was generated from the following file:

Content/Item.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addPlacementAdvice()

◆ fromJson()

◆ fromJsonItem()

◆ fromJsonObject()

◆ setHideOnCreate()

◆ setHtml()

◆ setIcon()

◆ setMediaType()

◆ setText()

◆ setThumbnail()

◆ setTitle()

◆ setUrl()

◆ toJson()

◆ toJsonldObject()

◆ toJsonObject()

Field Documentation

◆ LTI_ASSIGNMENT_MEDIA_TYPE

◆ LTI_LINK_MEDIA_TYPE

◆ TYPE_FILE

◆ TYPE_HTML

◆ TYPE_IMAGE

◆ TYPE_LINK

◆ TYPE_LTI_ASSIGNMENT

◆ TYPE_LTI_LINK