IMSGlobal\LTI\ToolProvider\ContentItem Class Reference

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

Collaboration diagram for IMSGlobal\LTI\ToolProvider\ContentItem:

Public Member Functions
	__construct ($type, $placementAdvice=null, $id=null)
	Class constructor. More...
	setUrl ($url)
	Set a URL value for the content-item. More...
	setMediaType ($mediaType)
	Set a media type value for the content-item. More...
	setTitle ($title)
	Set a title value for the content-item. More...
	setText ($text)
	Set a link text value for the content-item. More...

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

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

Detailed Description

Class to represent a content-item object.

Author

Stephen P Vickers svick.nosp@m.ers@.nosp@m.imsgl.nosp@m.obal.nosp@m..org

Copyright

IMS Global Learning Consortium Inc

Date

2016

Version

3.0.2 @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0

Definition at line 14 of file ContentItem.php.

Constructor & Destructor Documentation

__construct()

IMSGlobal\LTI\ToolProvider\ContentItem::__construct	(		$type,
			$placementAdvice = null,
			$id = null
	)

Class constructor.

Parameters

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

Definition at line 29 of file ContentItem.php.

    {
 
        $this->{'@type'} = $type;
        if (is_object($placementAdvice) && (count(get_object_vars($placementAdvice)) > 0)) {
            $this->placementAdvice = $placementAdvice;
        }
        if (!empty($id)) {
            $this->{'@id'} = $id;
        }
 
    }

References $id, and $type.

Member Function Documentation

setMediaType()

IMSGlobal\LTI\ToolProvider\ContentItem::setMediaType

(

$mediaType

)

Set a media type value for the content-item.

Parameters

string

$mediaType

Media type value

Definition at line 63 of file ContentItem.php.

    {
 
        if (!empty($mediaType)) {
            $this->mediaType = $mediaType;
        } else {
            unset($this->mediaType);
        }
 
    }

setText()

IMSGlobal\LTI\ToolProvider\ContentItem::setText

(

$text

)

Set a link text value for the content-item.

Parameters

string

$text

Link text value

Definition at line 95 of file ContentItem.php.

    {
 
        if (!empty($text)) {
            $this->text = $text;
        } else if (isset($this->text)) {
            unset($this->text);
        }
 
    }

References $text.

setTitle()

IMSGlobal\LTI\ToolProvider\ContentItem::setTitle

(

$title

)

Set a title value for the content-item.

Parameters

string

$title

Title value

Definition at line 79 of file ContentItem.php.

    {
 
        if (!empty($title)) {
            $this->title = $title;
        } else if (isset($this->title)) {
            unset($this->title);
        }
 
    }

References $title.

setUrl()

IMSGlobal\LTI\ToolProvider\ContentItem::setUrl

(

$url

)

Set a URL value for the content-item.

Parameters

string

$url

URL value

Definition at line 47 of file ContentItem.php.

    {
 
        if (!empty($url)) {
            $this->url = $url;
        } else {
            unset($this->url);
        }
 
    }

References $url.

toJson()

static IMSGlobal\LTI\ToolProvider\ContentItem::toJson (   $items )

static

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

Parameters

mixed

$items

An array of content items or a single item

Returns

string

Definition at line 112 of file ContentItem.php.

    {
/*
        $data = array();
        if (!is_array($items)) {
            $data[] = json_encode($items);
        } else {
            foreach ($items as $item) {
                $data[] = json_encode($item);
            }
        }
        $json = '{ "@context" : "http://purl.imsglobal.org/ctx/lti/v1/ContentItem", "@graph" : [' . implode(", ", $data) . '] }';
*/
        $obj = new \stdClass();
        $obj->{'@context'} = 'http://purl.imsglobal.org/ctx/lti/v1/ContentItem';
        if (!is_array($items)) {
          $obj->{'@graph'} = array();
          $obj->{'@graph'}[] = $items;
        } else {
          $obj->{'@graph'} = $items;
        }
 
        return json_encode($obj);
 
    }

Field Documentation

LTI_LINK_MEDIA_TYPE

const IMSGlobal\LTI\ToolProvider\ContentItem::LTI_LINK_MEDIA_TYPE = 'application/vnd.ims.lti.v1.ltilink'

Media type for LTI launch links.

Definition at line 20 of file ContentItem.php.

---

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

• libs/composer/vendor/imsglobal/lti/src/ToolProvider/ContentItem.php