◆ delegated_section_id()
static core_courseformat\sectiondelegatemodule::delegated_section_id |
( |
stdClass|cm_info | $cm | ) |
|
|
staticinherited |
Get the delegated section id controlled by a specific cm.
This method is used when reverse search is needed bu we cannot access the database. This happens mostly on backup and restore. Do NOT use for normal operations.
- Parameters
-
stdClass | cm_info | $cm | a course module compatible data structure. |
- Return values
-
◆ get_cm()
core_courseformat\sectiondelegatemodule::get_cm |
( |
| ) |
|
|
inherited |
Get the course object.
- Return values
-
◆ get_course()
core_courseformat\sectiondelegatemodule::get_course |
( |
| ) |
|
|
inherited |
Get the course object.
- Return values
-
◆ get_delegate_class_name()
static core_courseformat\sectiondelegate::get_delegate_class_name |
( |
string | $pluginname | ) |
|
|
staticprotectedinherited |
Return the delgate class name of a plugin, if any.
- Parameters
-
- Return values
-
string|null | the delegate class name or null if not found. |
◆ get_parent_section()
core_courseformat\sectiondelegatemodule::get_parent_section |
( |
| ) |
|
|
inherited |
◆ get_section_action_menu()
core_courseformat\sectiondelegatemodule::get_section_action_menu |
( |
course_format | $format, |
|
|
controlmenu | $controlmenu, |
|
|
renderer_base | $output ) |
|
inherited |
Allow delegate plugin to modify the available section menu.
- Parameters
-
course_format | $format | The course format instance. |
controlmenu | $controlmenu | The control menu instance. |
renderer_base | $output | The renderer instance. |
- Return values
-
action_menu|null | The new action menu with the list of edit control items or null if no action menu is available. |
Reimplemented from core_courseformat\sectiondelegate.
◆ has_delegate_class()
static core_courseformat\sectiondelegate::has_delegate_class |
( |
string | $pluginname | ) |
|
|
staticinherited |
Check if a plugin has a delegate class.
- Parameters
-
- Return values
-
◆ instance()
static core_courseformat\sectiondelegate::instance |
( |
section_info | $sectioninfo | ) |
|
|
staticinherited |
Get the section info instance if available.
- Parameters
-
- Return values
-
◆ is_enabled()
core_courseformat\sectiondelegatemodule::is_enabled |
( |
| ) |
|
|
inherited |
◆ preprocess_section_name()
core_courseformat\sectiondelegatemodule::preprocess_section_name |
( |
section_info | $section, |
|
|
?string | $newname ) |
|
inherited |
◆ put_section_state_extra_updates()
core_courseformat\sectiondelegatemodule::put_section_state_extra_updates |
( |
section_info | $section, |
|
|
stateupdates | $updates ) |
|
inherited |
◆ section_updated()
core_courseformat\sectiondelegatemodule::section_updated |
( |
stdClass | $sectionrecord | ) |
|
|
inherited |
Handler executed when a section has been updated.
This method uses a record instead of a section_info object because section updates can be done in batch and the course_info may not be yet updated.
This method does not need to recalculate the section_info object.
- Parameters
-
stdClass | $sectionrecord | the new section data |
Reimplemented from core_courseformat\sectiondelegate.
The documentation for this class was generated from the following file:
- mod/subsection/classes/courseformat/sectiondelegate.php