|
cm_info module_context | $context |
| The course module.
|
|
stdClass stdClass | $course |
| $course
|
|
courseformat courseformat | $format |
| $format the course format
|
|
◆ __construct()
Constructor.
- Parameters
-
- Parameters
-
$rendererhelper | $rendererhelper the renderer helper |
◆ get_actions_overview()
mod_assign\courseformat\overview::get_actions_overview |
( |
| ) |
|
◆ get_completion_overview()
core_courseformat\activityoverviewbase::get_completion_overview |
( |
| ) |
|
|
inherited |
Retrieves the completion overview for the activity.
- Return values
-
overviewitem|null | null if completion is not enabled. |
◆ get_due_date_overview()
mod_assign\courseformat\overview::get_due_date_overview |
( |
| ) |
|
◆ get_extra_overview_items()
mod_assign\courseformat\overview::get_extra_overview_items |
( |
| ) |
|
Get the plugin specific overview items for the activity.
Plugins can override this method to provide their own overview items.
The resulting array must be indexed by item shortname.
- Return values
-
overviewitem[] | Array of overview items indexed by item shortname. |
Reimplemented from core_courseformat\activityoverviewbase.
◆ get_grade_item_names()
core_courseformat\activityoverviewbase::get_grade_item_names |
( |
array | $items | ) |
|
|
protectedinherited |
Retrieves the grade item names for the activity.
By default, the overview will display the grade if the activities has only one grade item. The name of the grade item will be 'Grade'. For plugins with multiple grade items, the plugin must override this method and provide names for each grade item that want to be displayed.
- Parameters
-
- Return values
-
array<integer,string> | the grade item names indexed by item id. |
Reimplemented in mod_workshop\courseformat\overview.
◆ get_grades_overviews()
core_courseformat\activityoverviewbase::get_grades_overviews |
( |
| ) |
|
|
inherited |
Retrieves the grades overview items for the activity.
Most activities will have none or one grade. However, some activities may have multiple grades, such as workshop or quiz.
It is not recommended to override this method unless the plugin has specific requirements. Instead, plugins should override get_grade_item_names to provide the grade item names.
- Return values
-
overviewitem[] | Array of overview items representing the grades. |
◆ redirect_to_overview_page()
static core_courseformat\activityoverviewbase::redirect_to_overview_page |
( |
int | $courseid, |
|
|
string | $modname ) |
|
staticinherited |
Redirects to the overview page for the activity.
- Parameters
-
int | $courseid | The course id. |
string | $modname | The module name. |
The documentation for this class was generated from the following file:
- mod/assign/classes/courseformat/overview.php