enrol_lti\local\ltiadvantage\entity\ags_info Class Reference

The ags_info class, instances of which represent grade service information for a resource_link or context. More...

Public Member Functions
	get_lineitemscope ()
	Get the authorization scope for lineitems.
	get_lineitemsurl ()
	Get the url for querying line items, if supported.
	get_lineitemurl ()
	Get the single line item url, in cases where only one line item exists.
	get_resultscope ()
	Get the authorization scope for results.
	get_scopes ()
	Get all supported scopes for this service.
	get_scorescope ()
	Get the authorization scope for scores.

Static Public Member Functions
static	create (?\moodle_url $lineitemsurl=null, ?\moodle_url $lineitemurl=null, array $scopes=[])
	Factory method to create a new ags_info instance.

Detailed Description

The ags_info class, instances of which represent grade service information for a resource_link or context.

For information about Assignment and Grade Services 2.0, see https://www.imsglobal.org/spec/lti-ags/v2p0/.

Copyright

2021 Jake Dallimore jrhda.nosp@m.llim.nosp@m.ore@g.nosp@m.mail.nosp@m..com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

create()

static enrol_lti\local\ltiadvantage\entity\ags_info::create ( ?\moodle_url $lineitemsurl = null, ?\moodle_url $lineitemurl = null, array $scopes = [] )

static

Factory method to create a new ags_info instance.

Parameters

moodle_url | null	$lineitemsurl	The service URL used to get/put lineitems, if supported.
moodle_url | null	$lineitemurl	The lineitemurl, which is only present when a single lineitem is supported.
array	$scopes	The array of supported scopes for this service instance.

Return values

ags_info

the object instance.

get_lineitemscope()

enrol_lti\local\ltiadvantage\entity\ags_info::get_lineitemscope

(

)

Get the authorization scope for lineitems.

Return values

array|null

the scopes, if present, else null.

get_lineitemsurl()

enrol_lti\local\ltiadvantage\entity\ags_info::get_lineitemsurl

(

)

Get the url for querying line items, if supported.

Return values

moodle_url

the url.

get_lineitemurl()

enrol_lti\local\ltiadvantage\entity\ags_info::get_lineitemurl

(

)

Get the single line item url, in cases where only one line item exists.

Return values

moodle_url|null

the url, or null if not present.

get_resultscope()

enrol_lti\local\ltiadvantage\entity\ags_info::get_resultscope

(

)

Get the authorization scope for results.

Return values

string|null

the scope, if present, else null.

get_scopes()

enrol_lti\local\ltiadvantage\entity\ags_info::get_scopes

(

)

Get all supported scopes for this service.

Return values

string[]

the array of supported scopes.

get_scorescope()

enrol_lti\local\ltiadvantage\entity\ags_info::get_scorescope

(

)

Get the authorization scope for scores.

Return values

string|null

the scope, if present, else null.

---

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

• enrol/lti/classes/local/ltiadvantage/entity/ags_info.php