LtiLinkItem Class Reference

Class to represent an LTI link content-item object. More...

Inheritance diagram for LtiLinkItem:

Public Member Functions
	__construct (array|Placement|null $placementAdvices=null, ?string $id=null)
	Class constructor.
void	addCustom (string $name, ?string $value=null)
	Add a custom parameter for the content-item.
void	setLineItem (?LineItem $lineItem)
	Set a line-item for the content-item.
void	setAvailable (?TimePeriod $available)
	Set an availability time period for the content-item.
void	setSubmission (?TimePeriod $submission)
	Set a submission time period for the content-item.
void	setNoUpdate (?bool $noUpdate)
	Set whether the content-item should not be allowed to be updated.
object	toJsonldObject ()
	Wrap the content item to form an item complying with the application/vnd.ims.lti.v1.contentitems+json media type.
object	toJsonObject ()
	Wrap the content items to form a complete value for the https://purl.imsglobal.org/spec/lti-dl/claim/content_items claim.
Public Member Functions inherited from Item
	__construct (string $type, array|Placement|null $placementAdvices=null, ?string $id=null)
	Class constructor.
void	setUrl (?string $url)
	Set a URL value for the content-item.
void	setMediaType (?string $mediaType)
	Set a media type value for the content-item.
void	setTitle (?string $title)
	Set a title value for the content-item.
void	setText (?string $text)
	Set a link text value for the content-item.
void	setHtml (?string $html)
	Set an HTML embed value for the content-item.
bool	addPlacementAdvice (?Placement $placementAdvice)
	Add a placement for the content-item.
void	setIcon (?Image $icon)
	Set an icon image for the content-item.
void	setThumbnail (?Image $thumbnail)
	Set a thumbnail image for the content-item.
void	setHideOnCreate (?bool $hideOnCreate)
	Set whether the content-item should be hidden from learners by default.

Protected Member Functions
bool	fromJsonObject (object $item)
	Extract content-item details from its JSON representation.
Protected Member Functions inherited from Item

Additional Inherited Members
Static Public Member Functions inherited from Item
static string	toJson (array|Item $items, LtiVersion $ltiVersion=LtiVersion::V1)
	Wrap the content items to form a complete application/vnd.ims.lti.v1.contentitems+json media type instance.
static array	fromJson (object|array $items)
	Generate an array of Item objects from their JSON representation.
static Item LtiLinkItem FileItem null	fromJsonItem (object $item)
	Generate an Item object from its JSON or JSON-LD representation.
Public Attributes 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.

Detailed Description

Class to represent an LTI link 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

Constructor & Destructor Documentation

__construct()

__construct	(	array|Placement|null	$placementAdvices = null,
		?string	$id = null )

Class constructor.

Parameters

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 LtiAssignmentItem.

Member Function Documentation

addCustom()

void addCustom	(	string	$name,
		?string	$value = null )

Add a custom parameter for the content-item.

Parameters

string	$name	Name of parameter
string | null	$value	Value of parameter

fromJsonObject()

bool fromJsonObject ( object $item )

protected

Extract content-item details from its JSON representation.

Parameters

object

$item

A JSON object representing an LTI link content-item

Returns

bool True if the item is valid

Reimplemented from Item.

setAvailable()

void setAvailable

(

?TimePeriod

$available

)

Set an availability time period for the content-item.

Parameters

TimePeriod | null

$available

Time period

setLineItem()

void setLineItem

(

?LineItem

$lineItem

)

Set a line-item for the content-item.

Parameters

LineItem | null

$lineItem

Line-item

setNoUpdate()

void setNoUpdate

(

?bool

$noUpdate

)

Set whether the content-item should not be allowed to be updated.

Parameters

bool | null

$noUpdate

True if the item should not be updatable

setSubmission()

void setSubmission

(

?TimePeriod

$submission

)

Set a submission time period for the content-item.

Parameters

TimePeriod | null

$submission

Time period

toJsonldObject()

object toJsonldObject

(

)

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 from Item.

toJsonObject()

object toJsonObject

(

)

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 from Item.