LineItem Class Reference

Class to implement the Line-item service. More...

Inheritance diagram for LineItem:

Public Member Functions
	__construct ($platform, $endpoint, $limit=null, $pagingMode=false)
	Class constructor.
	getAll ($ltiResourceLinkId=null, $resourceId=null, $tag=null, $limit=null)
	Retrieve all line-items.
	createLineItem ($lineItem)
	Create a new line-item.
	saveLineItem ($lineItem)
	Save a line-item.
	deleteLineItem ($lineItem)
	Delete a line-item.
Public Member Functions inherited from AssignmentGrade
	__construct ($platform, $endpoint, $path='')
	Class constructor.
Public Member Functions inherited from Service
	__construct ($platform, $endpoint)
	Class constructor.
	getConsumer ()
	Get tool consumer.
	getPlatform ()
	Get platform.
	getScope ()
	Get access scope.
	send ($method, $parameters=array(), $body=null)
	Send a service request.
	getHttpMessage ()
	Get HttpMessage object for last request.

Static Public Member Functions
static	getLineItem ($platform, $endpoint)
	Retrieve a line item.

Data Fields
const	MEDIA_TYPE_LINE_ITEM = 'application/vnd.ims.lis.v2.lineitem+json'
	Line-item media type.
const	MEDIA_TYPE_LINE_ITEMS = 'application/vnd.ims.lis.v2.lineitemcontainer+json'
	Line-item container media type.
Data Fields inherited from Service
	$unsigned = false
	Whether service request should be sent unsigned.

Static Public Attributes
static	$SCOPE = 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem'
	Access scope.
static	$SCOPE_READONLY = 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem.readonly'
	Read-only access scope.
static	$defaultLimit = null
	Default limit on size of container to be returned from requests.

Additional Inherited Members
Protected Member Functions inherited from Service
	parseContextsInArray ($contexts, $arr)
	Parse the JSON for context references.
Protected Attributes inherited from Service
	$endpoint = null
	Service endpoint.
	$scope = null
	Service access scope.
	$mediaType = null
	Media type of message body.

Detailed Description

Class to implement the Line-item service.

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 15 of file Service/LineItem.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$platform,
			$endpoint,
			$limit = null,
			$pagingMode = false
	)

Class constructor.

Parameters

Platform	$platform	Platform object for this service request
string	$endpoint	Service endpoint
int | null	$limit	Limit of line-items to be returned in each request, null for all
bool	$pagingMode	True if only a single page should be requested when a limit is set

Definition at line 69 of file Service/LineItem.php.

References LineItem\$endpoint.

Member Function Documentation

createLineItem()

createLineItem

(

$lineItem

)

Create a new line-item.

Parameters

LTI\LineItem

$lineItem

Line-item object

Returns

bool True if successful

Definition at line 147 of file Service/LineItem.php.

References LineItem\getPlatform(), and Service\send().

deleteLineItem()

deleteLineItem

(

$lineItem

)

Delete a line-item.

Parameters

LTI\LineItem

$lineItem

Line-item object

Returns

bool True if successful

Definition at line 192 of file Service/LineItem.php.

References Service\send().

getAll()

getAll	(		$ltiResourceLinkId = null,
			$resourceId = null,
			$tag = null,
			$limit = null
	)

Retrieve all line-items.

The returned items can be filtered by a resource link ID, a resource ID and/or a tag. Requests can also be limited to a number of items which may mean that multiple requests will be made to retrieve the full list.

Parameters

string | null	$ltiResourceLinkId	LTI resource link ID (optional)
string | null	$resourceId	Tool resource ID (optional)
string | null	$tag	Tag (optional)
int | null	$limit	Limit of line-items to be returned in each request, null for service default (optional)

Returns

LTI\LineItem[]|bool Array of LineItem objects or false on error

Definition at line 91 of file Service/LineItem.php.

References LineItem\$endpoint, LineItem\$ltiResourceLinkId, LineItem\$resourceId, LineItem\$tag, LineItem\getPlatform(), and Service\send().

getLineItem()

static getLineItem (   $platform,   $endpoint  )

static

Retrieve a line item.

Parameters

Platform	$platform	Platform object for this service request
string	$endpoint	Line-item endpoint

Returns

LTI\LineItem|bool LineItem object, or false on error

Definition at line 208 of file Service/LineItem.php.

References LineItem\$endpoint.

saveLineItem()

saveLineItem

(

$lineItem

)

Save a line-item.

Parameters

LTI\LineItem

$lineItem

Line-item object

Returns

bool True if successful

Definition at line 170 of file Service/LineItem.php.

References LineItem\getPlatform(), and Service\send().

Field Documentation

$defaultLimit

$defaultLimit = null

static

Default limit on size of container to be returned from requests.

Definition at line 41 of file Service/LineItem.php.

$SCOPE

$SCOPE = 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem'

static

Access scope.

Definition at line 31 of file Service/LineItem.php.

$SCOPE_READONLY

$SCOPE_READONLY = 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem.readonly'

static

Read-only access scope.

Definition at line 36 of file Service/LineItem.php.

MEDIA_TYPE_LINE_ITEM

const MEDIA_TYPE_LINE_ITEM = 'application/vnd.ims.lis.v2.lineitem+json'

Line-item media type.

Definition at line 21 of file Service/LineItem.php.

MEDIA_TYPE_LINE_ITEMS

const MEDIA_TYPE_LINE_ITEMS = 'application/vnd.ims.lis.v2.lineitemcontainer+json'

Line-item container media type.

Definition at line 26 of file Service/LineItem.php.

---

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

• Service/LineItem.php