Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/course/classes/external/ -> course_summary_exporter.php (source)
Differences Between: [Versions 310 and 400] [Versions 39 and 400] [Versions 400 and 401] [Versions 400 and 402] [Versions 400 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. return: string|false url of course image or false if it's not exist. param: object $course |
| get_course_pattern($course) X-Ref |
| Get the course pattern datauri. The datauri is an encoded svg that can be passed as a url. return: string datauri param: object $course |
| get_course_progress($course) X-Ref |
| Get the course progress percentage. return: int progress param: object $course |
| coursecolor($courseid) X-Ref |
| Get the course color. return: string hex color code. param: int $courseid |
