LTI Integration Library 4.10.3
PHP class library for building LTI integrations
 
Loading...
Searching...
No Matches
AssessmentControl Class Reference

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

Inheritance diagram for AssessmentControl:
Service

Public Member Functions

 __construct ($resourceLink, $endpoint)
 Class constructor.
 
 submitAction ($assessmentControlAction, $user, $attemptNumber)
 Submit an assessment control action.
 
- 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 Attributes

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

Additional Inherited Members

- Data Fields inherited from Service
 $unsigned = false
 Whether service request should be sent unsigned.
 
- 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 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
Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 16 of file AssessmentControl.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $resourceLink,
  $endpoint 
)

Class constructor.

Parameters
ResourceLink$resourceLinkResource link object for this service request
string$endpointService endpoint

Reimplemented from Service.

Definition at line 39 of file AssessmentControl.php.

References Service\$endpoint, and AssessmentControl\$SCOPE.

Member Function Documentation

◆ submitAction()

submitAction (   $assessmentControlAction,
  $user,
  $attemptNumber 
)

Submit an assessment control action.

Parameters
AssessmentControlAction$assessmentControlActionAssessmentControlAction object
User$userUser object
int$attemptNumberAttempt number
Returns
string|bool Value of the status response, or false if not successful

Definition at line 56 of file AssessmentControl.php.

References Service\send().

Field Documentation

◆ $SCOPE

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

Access scope.

Definition at line 24 of file AssessmentControl.php.

Referenced by AssessmentControl\__construct().


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