Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

This file contains a class definition for the LineItem container resource

Author: Dirk Singels, Diego del Blanco, Claude Vervoort
Copyright: 2017 Cengage Learning http://www.cengage.com
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 302 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

lineitems:: (5 methods):
  __construct()
  execute()
  get_json_for_get_request()
  get_json_for_post_request()
  parse_value()


Class: lineitems  - X-Ref

A resource implementing LineItem container.

__construct($service)   X-Ref
Class constructor.

param: \ltiservice_gradebookservices\local\service\gradebookservices $service Service instance

execute($response)   X-Ref
Execute the request for this resource.

param: \mod_lti\local\ltiservice\response $response  Response object for this request.

get_json_for_get_request($items, $resourceid, $ltilinkid,$tag, $limitfrom, $limitnum, $totalcount, $typeid, $response)   X-Ref
Generate the JSON for a GET request.

param: array $items Array of lineitems
param: string $resourceid Resource identifier used for filtering, may be null
param: string $ltilinkid Resource Link identifier used for filtering, may be null
param: string $tag Tag identifier used for filtering, may be null
param: int $limitfrom Offset of the first line item to return
param: int $limitnum Maximum number of line items to return, ignored if zero or less
param: int $totalcount Number of total lineitems before filtering for paging
param: int $typeid Maximum number of line items to return, ignored if zero or less
param: \mod_lti\local\ltiservice\response $response
return: string

get_json_for_post_request($body, $contextid, $typeid)   X-Ref
Generate the JSON for a POST request.

param: string $body POST body
param: string $contextid Course ID
param: string $typeid
return: string

parse_value($value)   X-Ref
Parse a value for custom parameter substitution variables.

param: string $value String to be parsed
return: string