Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/course/format/classes/output/local/content/cm/ -> controlmenu.php (source)

[Source view]

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

Contains the default activity control menu.

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

Defines 1 class

controlmenu:: (4 methods):
  __construct()
  export_for_template()
  get_action_menu()
  cm_control_items()


Class: controlmenu  - X-Ref

Base class to render a course module menu 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

get_action_menu(\renderer_base $output)   X-Ref
Generate the aciton menu element.

This method is public in case some block needs to modify the menu before output it.
param: \renderer_base $output typically, the renderer that's calling this function
return: aciton_menu the activity action menu

cm_control_items()   X-Ref
Generate the edit control items of a course module.

This method uses course_get_cm_edit_actions function to get the cm actions.
However, format plugins can override the method to add or remove elements
from the menu.

return: array of edit control items