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.
/course/classes/external/ -> course_summary_exporter.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]

Class for exporting a course summary from an stdClass.

Copyright: 2015 Damyon Wiese
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 226 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

course_summary_exporter:: (10 methods):
  __construct()
  define_related()
  get_other_values()
  define_properties()
  get_format_parameters_for_summary()
  define_other_properties()
  get_course_image()
  get_course_pattern()
  get_course_progress()
  coursecolor()


Class: course_summary_exporter  - X-Ref

Class for exporting a course summary from an stdClass.

__construct($data, $related = array()   X-Ref
Constructor - saves the persistent object, and the related objects.

param: mixed $data - Either an stdClass or an array of values.
param: array $related - An optional list of pre-loaded objects related to this object.

define_related()   X-Ref
No description

get_other_values(renderer_base $output)   X-Ref
No description

define_properties()   X-Ref
No description

get_format_parameters_for_summary()   X-Ref
Get the formatting parameters for the summary.

return: array

define_other_properties()   X-Ref
No description

get_course_image($course)   X-Ref
Get the course image if added to course.

param: object $course
return: string|false url of course image or false if it's not exist.

get_course_pattern($course)   X-Ref
Get the course pattern datauri.

The datauri is an encoded svg that can be passed as a url.
param: object $course
return: string datauri

get_course_progress($course)   X-Ref
Get the course progress percentage.

param: object $course
return: int progress

coursecolor($courseid)   X-Ref
Get the course color.

param: int $courseid
return: string hex color code.