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 course format output class.

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

Defines 1 class

addsection:: (4 methods):
  __construct()
  export_for_template()
  get_num_sections_data()
  get_add_section_data()


Class: addsection  - X-Ref

Base class to render a course add section buttons.

__construct(course_format $format)   X-Ref
Constructor.

param: course_format $format the course format

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: stdClass data context for a mustache template

get_num_sections_data(\renderer_base $output, int $lastsection, int $maxsections)   X-Ref
Get the legacy num section add/remove section buttons data.

Current course format has 'numsections' option, which is very confusing and we suggest course format
developers to get rid of it (see MDL-57769 on how to do it).

param: \renderer_base $output typically, the renderer that's calling this function
param: int $lastsection the last section number
param: int $maxsections the maximum number of sections
return: stdClass data context for a mustache template

get_add_section_data(\renderer_base $output, int $lastsection, int $maxsections)   X-Ref
Get the add section button data.

Current course format does not have 'numsections' option but it has multiple sections suppport.
Display the "Add section" link that will insert a section in the end.
Note to course format developers: inserting sections in the other positions should check both
capabilities 'moodle/course:update' and 'moodle/course:movesections'.

param: \renderer_base $output typically, the renderer that's calling this function
param: int $lastsection the last section number
param: int $maxsections the maximum number of sections
return: stdClass data context for a mustache template