Grade helper class.
More...
Grade helper class.
This class provides several helpful functions that work irrespective of any current state.
- Copyright
- 2010 Sam Hemelryk
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ fetch_all_natural_weights_for_course()
static grade_helper::fetch_all_natural_weights_for_course |
( |
| $courseid | ) |
|
|
static |
This helper method gets a snapshot of all the weights for a course.
It is used as a quick method to see if any wieghts have been automatically adjusted.
- Parameters
-
- Return values
-
array | of itemid -> aggregationcoef2 |
◆ get_activity_link()
static grade_helper::get_activity_link |
( |
array | $element | ) |
|
|
static |
Returns a link to activity.
- Parameters
-
array | $element | An array representing an element in the grade_tree |
- Return values
-
moodle_url|null | link to activity or null if not found |
◆ get_aggregation_strings()
static grade_helper::get_aggregation_strings |
( |
| ) |
|
|
static |
Gets strings describing the available aggregation methods.
- Return values
-
◆ get_element_header()
static grade_helper::get_element_header |
( |
array | $element, |
|
|
bool | $withlink = false, |
|
|
bool | $icon = true, |
|
|
bool | $spacerifnone = false, |
|
|
bool | $withdescription = false, |
|
|
bool | $fulltotal = false, |
|
|
?moodle_url | $sortlink = null ) |
|
static |
Returns name of element optionally with icon and link.
- Parameters
-
array | $element | An array representing an element in the grade_tree |
bool | $withlink | Whether or not this header has a link |
bool | $icon | Whether or not to display an icon with this header |
bool | $spacerifnone | return spacer if no icon found |
bool | $withdescription | Show description if defined by this item. |
bool | $fulltotal | If the item is a category total, returns $categoryname."total" instead of "Category total" or "Course total" |
moodle_url | null | $sortlink | Link to sort column. |
- Return values
-
◆ get_element_icon()
static grade_helper::get_element_icon |
( |
array | $element, |
|
|
bool | $spacerifnone = false ) |
|
static |
Returns icon of element.
- Parameters
-
array | $element | An array representing an element in the grade_tree |
bool | $spacerifnone | return spacer if no icon found |
- Return values
-
◆ get_element_type_string()
static grade_helper::get_element_type_string |
( |
array | $element | ) |
|
|
static |
Returns the string that describes the type of the element.
- Parameters
-
array | $element | An array representing an element in the grade_tree |
- Return values
-
string | The string that describes the type of the grade element |
◆ get_info_letters()
static grade_helper::get_info_letters |
( |
| $courseid | ) |
|
|
static |
Get information on letters.
- Parameters
-
- Return values
-
◆ get_info_manage_settings()
static grade_helper::get_info_manage_settings |
( |
| $courseid | ) |
|
|
static |
Get grade_plugin_info object for managing settings if the user can.
- Parameters
-
- Return values
-
◆ get_info_outcomes()
static grade_helper::get_info_outcomes |
( |
| $courseid | ) |
|
|
static |
Get information on outcomes.
- Parameters
-
- Return values
-
grade_plugin_info[]|false | |
◆ get_info_scales()
static grade_helper::get_info_scales |
( |
| $courseid | ) |
|
|
static |
Get information on scales.
- Parameters
-
- Return values
-
◆ get_lang_string()
static grade_helper::get_lang_string |
( |
| ) |
|
|
static |
◆ get_plugin_strings()
static grade_helper::get_plugin_strings |
( |
| ) |
|
|
static |
Gets strings commonly used by the describe plugins.
report => get_string('view'), scale => get_string('scales'), outcome => get_string('outcomes', 'grades'), letter => get_string('letters', 'grades'), export => get_string('export', 'grades'), import => get_string('import'), settings => get_string('settings')
- Return values
-
◆ get_plugins_export()
static grade_helper::get_plugins_export |
( |
| $courseid | ) |
|
|
static |
Get information export plugins.
- Parameters
-
- Return values
-
◆ get_plugins_import()
static grade_helper::get_plugins_import |
( |
| $courseid | ) |
|
|
static |
Get information import plugins.
- Parameters
-
- Return values
-
◆ get_plugins_reports()
static grade_helper::get_plugins_reports |
( |
| $courseid | ) |
|
|
static |
Returns an array of plugin reports as grade_plugin_info objects.
- Parameters
-
- Return values
-
◆ get_user_field_value()
static grade_helper::get_user_field_value |
( |
| $user, |
|
|
| $field ) |
|
static |
Returns the value of a field from a user record.
- Parameters
-
stdClass | $user | object |
stdClass | $field | object |
- Return values
-
◆ get_user_profile_fields()
static grade_helper::get_user_profile_fields |
( |
| $courseid, |
|
|
| $includecustomfields = false ) |
|
static |
Returns an array of user profile fields to be included in export.
- Parameters
-
int | $courseid | |
bool | $includecustomfields | |
- Return values
-
array | An array of stdClass instances with customid, shortname, datatype, default and fullname fields |
◆ reset_caches()
static grade_helper::reset_caches |
( |
| ) |
|
|
static |
Resets all static caches.
- Return values
-
◆ $exportplugins
array false grade_helper::$exportplugins = null |
|
staticprotected |
Cached grade export plugins {.
- See also
- get_plugins_export}
◆ $gradereportpreferences
array false grade_helper::$gradereportpreferences = null |
|
staticprotected |
Cached grade report plugins preferences {.
- See also
- get_info_scales}
◆ $gradereports
array false grade_helper::$gradereports = null |
|
staticprotected |
Cached grade report plugins {.
- See also
- get_plugins_reports}
◆ $importplugins
array false grade_helper::$importplugins = null |
|
staticprotected |
Cached grade import plugins {.
- See also
- get_plugins_import}
◆ $letterinfo
Cached leftter info {.
- See also
- get_info_letters}
◆ $managesetting
Cached manage settings info {.
- See also
- get_info_settings}
◆ $outcomeinfo
Cached outcome info {.
- See also
- get_info_outcomes}
◆ $scaleinfo
Cached scale info {.
- See also
- get_info_scales}
The documentation for this class was generated from the following file: