ceLTIc\LTI\Content\LineItem Class Reference

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

Public Member Functions
	__construct (string $label, int|float $scoreMaximum, ?string $resourceId=null, ?string $tag=null, ?SubmissionReview $submissionReview=null, ?bool $gradesReleased=null)
	Class constructor.
object	toJsonldObject ()
	Generate the JSON-LD object representation of the line-item.
object	toJsonObject ()
	Generate the JSON object representation of the line-item.

Static Public Member Functions
static LineItem null	fromJsonObject (object $item)
	Generate a LineItem object from its JSON or JSON-LD representation.

Detailed Description

Class to represent a line-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()

ceLTIc\LTI\Content\LineItem::__construct	(	string	$label,
		int|float	$scoreMaximum,
		?string	$resourceId = null,
		?string	$tag = null,
		?SubmissionReview	$submissionReview = null,
		?bool	$gradesReleased = null )

Class constructor.

Parameters

string	$label	Label
int | float	$scoreMaximum	Maximum score
string | null	$resourceId	Resource ID (optional)
string | null	$tag	Tag (optional)
SubmissionReview | null	$submissionReview	Submission Review (optional)
bool | null	$gradesReleased	Grades should be released

References toJsonObject().

Member Function Documentation

fromJsonObject()

static LineItem null ceLTIc\LTI\Content\LineItem::fromJsonObject ( object $item )

static

Generate a LineItem object from its JSON or JSON-LD representation.

Parameters

object

$item

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

Returns

LineItem|null The LineItem object

toJsonldObject()

object ceLTIc\LTI\Content\LineItem::toJsonldObject

(

)

Generate the JSON-LD object representation of the line-item.

Returns

object JSON object

toJsonObject()

object ceLTIc\LTI\Content\LineItem::toJsonObject

(

)

Generate the JSON object representation of the line-item.

Returns

object JSON object

References ceLTIc\LTI\Util\checkNumber(), and ceLTIc\LTI\Util\checkString().

Referenced by __construct().