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.
Differences Between: [Versions 400 and 402] [Versions 400 and 403]
Contains the default activity title. This class is usually rendered inside the cmname inplace editable.
| Copyright: | 2020 Ferran Recio <ferran@moodle.com> |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 236 lines (8 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
title:: (6 methods):
__construct()
get_template_name()
export_for_template()
get_title_displayvalue()
load_display_options()
update()
Base class to render a course module title inside a course format.
| __construct(course_format $format,section_info $section,cm_info $mod,array $displayoptions = [],?bool $editable = null) 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 param: bool|null $editable force editable value |
| get_template_name(\renderer_base $renderer) X-Ref |
| Get the name of the template to use for this templatable. return: string param: \renderer_base $renderer The renderer requesting the template name |
| 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 |
| get_title_displayvalue() X-Ref |
| Return the title template data to be used inside the inplace editable. |
| load_display_options(array $displayoptions) X-Ref |
| Load the required display options if not present already. In most cases, display options are provided as a param when creating the object. However, inplace_editable and some blocks does not know all of them as it is called in a webservice and we need to ensure it is calculated. return: array the full display options list param: array $displayoptions the provided dispaly options |
| update($itemid, $newvalue) X-Ref |
| Updates course module name. This method is used mainly by inplace_editable webservice. return: static param: int $itemid course module id param: string $newvalue new name |
