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.

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [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: 230 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


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.