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.

Differences Between: [Versions 400 and 402] [Versions 401 and 402] [Versions 402 and 403]

Contains the default activity list from a section.

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

Defines 1 class


Class: cm  - X-Ref

Base class to render a course module inside a course format.

__construct(course_format $format, section_info $section, cm_info $mod, array $displayoptions = [])   X-Ref
Constructor.

param: course_format $format the course format
param: section_info $section the section info
param: cm_info $mod the course module ionfo
param: array $displayoptions optional extra display options

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_cm_name_data(stdClass &$data, renderer_base $output)   X-Ref
Add course module name 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_availability_data(stdClass &$data, renderer_base $output)   X-Ref
Add the module 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 mod availability

add_alternative_content_data(stdClass &$data, renderer_base $output)   X-Ref
Add the alternative content 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 alternative content

add_completion_data(stdClass &$data, renderer_base $output)   X-Ref
Add activity completion 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 the module has completion information

add_format_data(stdClass &$data, array $haspartials, renderer_base $output)   X-Ref
Add activity information 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 format data

add_editor_data(stdClass &$data, renderer_base $output)   X-Ref
Add course 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 editor data

load_classes()   X-Ref
Returns the CSS classes for the activity name/content


get_link_classes()   X-Ref
Get the activity link classes.

return: string the activity link classes.

get_text_classes()   X-Ref
Get the activity text/description classes.

return: string the activity text classes.

get_onclick_code()   X-Ref
Get the activity onclick code.

return: string the activity onclick.