Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Contains the default section summary (used for multipage format).

Copyright: 2020 Ferran Recio <ferran@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 97 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

summary:: (3 methods):
  __construct()
  export_for_template()
  format_summary_text()


Class: summary  - X-Ref

Base class to render a course section summary.

__construct(course_format $format, section_info $section)   X-Ref
Constructor.

param: course_format $format the course format
param: section_info $section the section info

export_for_template(\renderer_base $output)   X-Ref
Export this data so it can be used as the context for a mustache template.

param: renderer_base $output typically, the renderer that's calling this function
return: array data context for a mustache template

format_summary_text()   X-Ref
Generate html for a section summary text

return: string HTML to output.