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

Inheritance diagram for ContentItem:

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

Public Member Functions inherited from Item
	__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.

Additional Inherited Members
Static Public Member Functions inherited from Item
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 inherited from Item
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 inherited from Item
	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

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

Definition at line 18 of file ContentItem.php.

Constructor & Destructor Documentation

Class constructor.

Parameters

string	$type	Class type of content-item
ContentItemPlacement	$placementAdvice	Placement object for item (optional)
string	$id	URL of content-item (optional)

Reimplemented from Item.

Definition at line 28 of file ContentItem.php.

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