Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/course/format/classes/output/local/content/cm/ -> cmname.php (source)

[Source view]

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

Contains the default activity name inplace editable.

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

Defines 1 class

cmname:: (5 methods):
  __construct()
  export_for_template()
  get_title_data()
  get_icon_data()
  has_name()


Class: cmname  - X-Ref

Base class to render a course module inplace editable header.

__construct(course_format $format,section_info $section,cm_info $mod,?bool $unused = null,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: null $unused This parameter has been deprecated since 4.1 and should not be used anymore.
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_title_data(\renderer_base $output)   X-Ref
Get the title data.

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

get_icon_data(\renderer_base $output)   X-Ref
Get the icon data.

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

has_name()   X-Ref
Return if the activity has a visible name.

return: bool if the title is visible.