Search moodle.org's
Developer Documentation
Developer Documentation
- 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.
Differences Between: [Versions 400 and 402] [Versions 401 and 402]
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: | 364 lines (13 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
section:: (11 methods):
__construct()
hide_title()
hide_controls()
export_for_template()
add_header_data()
add_cm_data()
add_availability_data()
add_visibility_data()
add_editor_data()
add_format_data()
is_section_collapsed()
Base class to render a course section.
| __construct(course_format $format, section_info $section) X-Ref |
| Constructor. param: course_format $format the course format param: section_info $section the section info |
| hide_title() X-Ref |
| Hide the section title. This is used on blocks or in the home page where an isolated section is displayed. |
| hide_controls() X-Ref |
| Hide the section controls. This is used on blocks or in the home page where an isolated section is displayed. |
| 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 |
| add_header_data(stdClass &$data, renderer_base $output) X-Ref |
| Add the section header to the data structure. param: stdClass $data the current cm data reference param: renderer_base $output typically, the renderer that's calling this function return: bool if the cm has name data |
| add_cm_data(stdClass &$data, renderer_base $output) X-Ref |
| Add the section cm list to the data structure. param: stdClass $data the current cm data reference param: renderer_base $output typically, the renderer that's calling this function return: bool if the cm has name data |
| add_availability_data(stdClass &$data, renderer_base $output) X-Ref |
| Add the section availability to the data structure. param: stdClass $data the current cm data reference param: renderer_base $output typically, the renderer that's calling this function return: bool if the cm has name data |
| add_visibility_data(stdClass &$data, renderer_base $output) X-Ref |
| Add the section vibility information to the data structure. param: stdClass $data the current cm data reference param: renderer_base $output typically, the renderer that's calling this function return: bool if the cm has name data |
| add_editor_data(stdClass &$data, renderer_base $output) X-Ref |
| Add the section editor attributes to the data structure. param: stdClass $data the current cm data reference param: renderer_base $output typically, the renderer that's calling this function return: bool if the cm has name data |
| add_format_data(stdClass &$data, array $haspartials, renderer_base $output) X-Ref |
| Add the section format attributes to the data structure. param: stdClass $data the current cm data reference param: bool[] $haspartials the result of loading partial data elements param: renderer_base $output typically, the renderer that's calling this function return: bool if the cm has name data |
| is_section_collapsed() X-Ref |
| Returns true if the current section should be shown collapsed. return: bool |
