ceLTIc\LTI\Service\AssessmentControl Class Reference

Class to implement the Assessment Control service. More...

Inheritance diagram for ceLTIc\LTI\Service\AssessmentControl:

Public Member Functions
	__construct (ResourceLink $resourceLink, string $endpoint)
	Class constructor.
string bool	submitAction (AssessmentControlAction $assessmentControlAction, User $user, int $attemptNumber)
	Submit an assessment control action.
Public Member Functions inherited from ceLTIc\LTI\Service\Service
	__construct (Platform $platform, ?string $endpoint)
	Class constructor.
Platform	getPlatform ()
	Get platform.
string	getScope ()
	Get access scope.
HttpMessage	send (string $method, ?array $parameters=[], string $body='')
	Send a service request.
HttpMessage	getHttpMessage ()
	Get HttpMessage object for last request.

Public Attributes
const	MEDIA_TYPE_ASSESSMENT_CONTROL = 'application/vnd.ims.lti-ap.v1.control+json'
	Media type for the Assessment Control service.
Public Attributes inherited from ceLTIc\LTI\Service\Service
bool	$unsigned = false
	Whether service request should be sent unsigned.

Static Public Attributes
static string	$SCOPE = 'https://purl.imsglobal.org/spec/lti-ap/scope/control.all'
	Access scope.

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

Detailed Description

Class to implement the Assessment Control 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

Constructor & Destructor Documentation

__construct()

ceLTIc\LTI\Service\AssessmentControl::__construct	(	ResourceLink	$resourceLink,
		string	$endpoint )

Class constructor.

Parameters

ResourceLink	$resourceLink	Resource link object for this service request
string	$endpoint	Service endpoint

Member Function Documentation

submitAction()

string bool ceLTIc\LTI\Service\AssessmentControl::submitAction	(	AssessmentControlAction	$assessmentControlAction,
		User	$user,
		int	$attemptNumber )

Submit an assessment control action.

Parameters

AssessmentControlAction	$assessmentControlAction	AssessmentControlAction object
User	$user	User object
int	$attemptNumber	Attempt number

Returns

string|bool Value of the status response, or false if not successful

Member Data Documentation

$SCOPE

string ceLTIc\LTI\Service\AssessmentControl::$SCOPE = 'https://purl.imsglobal.org/spec/lti-ap/scope/control.all'

static

Access scope.

MEDIA_TYPE_ASSESSMENT_CONTROL

const ceLTIc\LTI\Service\AssessmentControl::MEDIA_TYPE_ASSESSMENT_CONTROL = 'application/vnd.ims.lti-ap.v1.control+json'

Media type for the Assessment Control service.