ILIAS  release_8 Revision v8.23
ilLTIConsumerGradeService Class Reference
+ Inheritance diagram for ilLTIConsumerGradeService:
+ Collaboration diagram for ilLTIConsumerGradeService:

Public Member Functions

 __construct ()
 Class constructor. More...
 
 getResources ()
 Get the resources for this service. More...
 
 getPermittedScopes ()
 Get the scope(s) permitted for this service. More...
 
 getScopes ()
 Get the scopes defined by this service. More...
 
- Public Member Functions inherited from ilLTIConsumerServiceBase
 __construct ()
 
 getResources ()
 Get the resources for this service. More...
 
 setResourcePath (string $resourcePath)
 Set the cleaned resourcePath without service part. More...
 
 getResourcePath ()
 Get cleaned resourcePath without service part. More...
 
 checkTool ()
 Check that the request has been properly signed and is permitted. More...
 

Data Fields

const GRADESERVICE_READ = 1
 Read-only access to Gradebook services. More...
 
const GRADESERVICE_FULL = 2
 Full access to Gradebook services. More...
 
const SCOPE_GRADESERVICE_LINEITEM = 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem'
 Scope for full access to Lineitem service. More...
 
const SCOPE_GRADESERVICE_LINEITEM_READ = 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem.readonly'
 Scope for full access to Lineitem service. More...
 
const SCOPE_GRADESERVICE_RESULT_READ = 'https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly'
 Scope for access to Result service. More...
 
const SCOPE_GRADESERVICE_SCORE = 'https://purl.imsglobal.org/spec/lti-ags/scope/score'
 Scope for access to Score service. More...
 
- Data Fields inherited from ilLTIConsumerServiceBase
const LTI_VERSION2P0 = 'LTI-2p0'
 
const SERVICE_ENABLED = 1
 

Additional Inherited Members

- Protected Member Functions inherited from ilLTIConsumerServiceBase
 parseValue (string $value)
 Parse a string for custom substitution parameter variables supported by this service's resources. More...
 
- Protected Attributes inherited from ilLTIConsumerServiceBase
string $id
 ID for the service. More...
 
string $name
 Human readable name for the service. More...
 
bool $unsigned
 if requests for this service do not need to be signed. More...
 
array $resources
 Instances of the resources associated with this service. More...
 
string $resourcePath
 cleaned requested resourcePath More...
 

Detailed Description

Definition at line 30 of file class.ilLTIConsumerGradeService.php.

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumerGradeService::__construct ( )

Class constructor.

Definition at line 54 of file class.ilLTIConsumerGradeService.php.

References ILIAS\GlobalScreen\Provider\__construct().

55  {
57  $this->id = 'gradebookservice';
58  $this->name = 'ilLTIConsumerGradeService';
59  }
__construct(Container $dic, ilPlugin $plugin)
+ Here is the call graph for this function:

Member Function Documentation

◆ getPermittedScopes()

ilLTIConsumerGradeService::getPermittedScopes ( )

Get the scope(s) permitted for this service.

ToDo: make configurable

Definition at line 82 of file class.ilLTIConsumerGradeService.php.

References $scopes.

82  : array
83  {
84  $scopes = array();
85  $scopes[] = self::SCOPE_GRADESERVICE_LINEITEM;
86  $scopes[] = self::SCOPE_GRADESERVICE_LINEITEM_READ;
87  $scopes[] = self::SCOPE_GRADESERVICE_RESULT_READ;
88  $scopes[] = self::SCOPE_GRADESERVICE_SCORE;
89  return $scopes;
90  }
$scopes
Definition: ltitoken.php:99

◆ getResources()

ilLTIConsumerGradeService::getResources ( )

Get the resources for this service.

Definition at line 64 of file class.ilLTIConsumerGradeService.php.

References ilLTIConsumerServiceBase\$resources.

64  : array
65  {
66  // The containers should be ordered in the array after their elements.
67  // Lineitems should be after lineitem.
68  if (empty($this->resources)) {
69  $this->resources = array();
70  $this->resources[] = new ilLTIConsumerGradeServiceLineItem($this);
71  $this->resources[] = new ilLTIConsumerGradeServiceLineItems($this);
72  $this->resources[] = new ilLTIConsumerGradeServiceResults($this);
73  $this->resources[] = new ilLTIConsumerGradeServiceScores($this);
74  }
75  return $this->resources;
76  }
array $resources
Instances of the resources associated with this service.

◆ getScopes()

ilLTIConsumerGradeService::getScopes ( )

Get the scopes defined by this service.

Definition at line 95 of file class.ilLTIConsumerGradeService.php.

95  : array
96  {
97  return [
98  self::SCOPE_GRADESERVICE_LINEITEM_READ,
99  self::SCOPE_GRADESERVICE_RESULT_READ,
100  self::SCOPE_GRADESERVICE_SCORE,
101  self::SCOPE_GRADESERVICE_LINEITEM
102  ];
103  }

Field Documentation

◆ GRADESERVICE_FULL

const ilLTIConsumerGradeService::GRADESERVICE_FULL = 2

Full access to Gradebook services.

Definition at line 36 of file class.ilLTIConsumerGradeService.php.

◆ GRADESERVICE_READ

const ilLTIConsumerGradeService::GRADESERVICE_READ = 1

Read-only access to Gradebook services.

Definition at line 33 of file class.ilLTIConsumerGradeService.php.

◆ SCOPE_GRADESERVICE_LINEITEM

const ilLTIConsumerGradeService::SCOPE_GRADESERVICE_LINEITEM = 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem'

Scope for full access to Lineitem service.

Definition at line 39 of file class.ilLTIConsumerGradeService.php.

◆ SCOPE_GRADESERVICE_LINEITEM_READ

const ilLTIConsumerGradeService::SCOPE_GRADESERVICE_LINEITEM_READ = 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem.readonly'

Scope for full access to Lineitem service.

Definition at line 42 of file class.ilLTIConsumerGradeService.php.

◆ SCOPE_GRADESERVICE_RESULT_READ

const ilLTIConsumerGradeService::SCOPE_GRADESERVICE_RESULT_READ = 'https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly'

Scope for access to Result service.

Definition at line 45 of file class.ilLTIConsumerGradeService.php.

◆ SCOPE_GRADESERVICE_SCORE

const ilLTIConsumerGradeService::SCOPE_GRADESERVICE_SCORE = 'https://purl.imsglobal.org/spec/lti-ags/scope/score'

Scope for access to Score service.

Definition at line 48 of file class.ilLTIConsumerGradeService.php.

Referenced by ilLTIConsumerGradeServiceScores\execute().


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