Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/enrol/lti/classes/local/ltiadvantage/viewobject/ -> published_resource.php (source)

[Source view]

(no description)

File Size: 164 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

published_resource:: (10 methods):
  __construct()
  get_name()
  get_coursefullname()
  get_courseid()
  get_contextid()
  get_id()
  get_uuid()
  supports_grades()
  get_grademax()
  is_course()


Class: published_resource  - X-Ref

The class published_resource, instances of which represent a specific VIEW of a published resource.

This class performs no validation and is only meant to be used as a slice of the existing data for use in the
content selection flow.

__construct(string $name, string $coursefullname, int $courseid, int $contextid, int $id,string $uuid, bool $supportsgrades, ?float $grademax, bool $iscourse)   X-Ref
The published_resource constructor.

param: string $name the name of this resource.
param: string $coursefullname full name of the course to which this published resource belongs.
param: int $courseid id of the course to which this published resource belongs.
param: int $contextid id of the context.
param: int $id id of the enrol_lti_tools instance (i.e. the id of the 'published resource').
param: string $uuid a v4 uuid identifier for this published resource.
param: bool $supportsgrades whether or not this resource supports grades.
param: float|null $grademax the max grade or null if this is not a graded resource.
param: bool $iscourse whether or not this resource is itself a course.

get_name()   X-Ref
Get the name of this published resource.

return: string the localised name.

get_coursefullname()   X-Ref
Get the full name of the course owning this published resource.

return: string the localised course full name.

get_courseid()   X-Ref
Get the id of the course owning this published resource.

return: int the course id.

get_contextid()   X-Ref
Get the id of the context for this published resource.

return: int the context id.

get_id()   X-Ref
Get the id of this published resource.

return: int the id.

get_uuid()   X-Ref
Get the uuid for this published resource.

return: string v4 uuid.

supports_grades()   X-Ref
Check whether this resource supports grades or not.

return: bool true if supported, false otherwise.

get_grademax()   X-Ref
Get the max grade for this published resource, if its a graded resource.

return: float|null the grade max, if grades are supported, else null.

is_course()   X-Ref
Check whether this published resource is a course itself.

return: bool true if it's a course, false otherwise.