Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/course/format/classes/output/local/content/ -> cm.php (source)
Differences Between: [Versions 400 and 402] [Versions 400 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: | 349 lines (13 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
cm:: (12 methods):
__construct()
export_for_template()
add_cm_name_data()
add_availability_data()
add_alternative_content_data()
add_completion_data()
add_format_data()
add_editor_data()
load_classes()
get_link_classes()
get_text_classes()
get_onclick_code()
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. return: stdClass data context for a mustache template param: renderer_base $output typically, the renderer that's calling this function |
| add_cm_name_data(stdClass &$data, renderer_base $output) X-Ref |
| Add course module name attributes to the data structure. return: bool if the cm has name data param: stdClass $data the current cm data reference param: renderer_base $output typically, the renderer that's calling this function |
| add_availability_data(stdClass &$data, renderer_base $output) X-Ref |
| Add the module availability to the data structure. return: bool if the cm has mod availability param: stdClass $data the current cm data reference param: renderer_base $output typically, the renderer that's calling this function |
| add_alternative_content_data(stdClass &$data, renderer_base $output) X-Ref |
| Add the alternative content to the data structure. return: bool if the cm has alternative content param: stdClass $data the current cm data reference param: renderer_base $output typically, the renderer that's calling this function |
| add_completion_data(stdClass &$data, renderer_base $output) X-Ref |
| Add activity completion information to the data structure. return: bool the module has completion information param: stdClass $data the current cm data reference param: renderer_base $output typically, the renderer that's calling this function |
| add_format_data(stdClass &$data, array $haspartials, renderer_base $output) X-Ref |
| Add activity information to the data structure. return: bool if the cm has format data 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 |
| add_editor_data(stdClass &$data, renderer_base $output) X-Ref |
| Add course editor attributes to the data structure. return: bool if the cm has editor data param: stdClass $data the current cm data reference param: renderer_base $output typically, the renderer that's calling this function |
| 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. |
