Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
This class represents a complete tree of categories, grade_items and final grades, organises as an array primarily, but which can also be converted to other formats. More...
Public Member Functions | |
__construct ($courseid, $fillers=true, $category_grade_last=false, $collapsed=null, $nooutcomes=false) | |
Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item objects for the given courseid. | |
category_collapse (&$element, $collapsed) | |
Static recursive helper - removes items from collapsed categories. | |
category_grade_last (&$element) | |
Static recursive helper - makes the grade_item for category the last children. | |
exporttojson ($root=null, $tabs="\t") | |
Returns a JSON representation of the grade-tree using recursion. | |
exporttoxml ($root=null, $tabs="\t") | |
Returns a well-formed XML representation of the grade-tree using recursion. | |
fill_levels (&$levels, &$element, $depth) | |
Static recursive helper - fills the levels array, useful when accessing tree elements of one level. | |
get_advanced_grading_link (array $element, object $gpr) | |
Returns link to the advanced grading page. | |
get_calculation_icon ($element, $gpr, $returnactionmenulink=false) | |
Return calculation icon for given element. | |
get_cell_action_menu (array $element, string $mode, grade_plugin_return $gpr, ?moodle_url $baseurl=null) | |
Returns an action menu for the grade. | |
get_delete_link (array $element, object $gpr) | |
Returns a link to delete a given element. | |
get_duplicate_link (array $element, object $gpr) | |
Returns a link to duplicate a given element. | |
get_edit_calculation_link (array $element, object $gpr) | |
Returns link to edit calculation for a grade item. | |
get_edit_icon ($element, $gpr, $returnactionmenulink=false) | |
Return edit icon for give element. | |
get_edit_link (array $element, object $gpr) | |
Returns a link leading to the edit grade/grade item/category page. | |
get_element_header (array &$element, bool $withlink=false, bool $icon=true, bool $spacerifnone=false, bool $withdescription=false, bool $fulltotal=false, ?moodle_url $sortlink=null) | |
Returns name of element optionally with icon and link. | |
get_element_icon (&$element, $spacerifnone=false) | |
Returns icon of element. | |
get_element_type_string (array $element) | |
Returns the string that describes the type of the element. | |
get_grade_action_menu (grade_grade $grade) | |
Returns an action menu for the grade. | |
get_grade_analysis_icon (grade_grade $grade) | |
Returns an action icon leading to the grade analysis page. | |
get_grade_analysis_link (grade_grade $grade) | |
Returns a link leading to the grade analysis page. | |
get_grade_analysis_url (grade_grade $grade) | |
Returns URL of a page that is supposed to contain detailed grade analysis. | |
get_grade_eid ($grade_grade) | |
Returns the grade eid - the grade may not exist yet. | |
get_hiding_icon ($element, $gpr, $returnactionmenulink=false) | |
Return hiding icon for give element. | |
get_hiding_link (array $element, object $gpr) | |
Returns a link with url to hide/unhide grade/grade item/grade category. | |
get_item ($itemid) | |
Returns a specific Grade Item. | |
get_item_eid ($grade_item) | |
Returns the grade_item eid. | |
get_items () | |
Returns the array of grade items. | |
get_levels () | |
Returns the array of levels. | |
get_locking_icon ($element, $gpr) | |
Return locking icon for given element. | |
get_locking_link (array $element, object $gpr) | |
Returns link to lock/unlock grade/grade item/grade category. | |
get_params_for_iconstr ($element) | |
Given a grade_tree element, returns an array of parameters used to build an icon for that element. | |
get_reset_icon ($element, $gpr, $returnactionmenulink=false) | |
Return a reset icon for the given element. | |
get_reset_weights_link (array $element, object $gpr) | |
Returns a link to reset weights for the given element. | |
get_sorting_link (moodle_url $sortlink, object $gpr, string $direction='asc') | |
Returns link to sort grade item column. | |
grade_tree ($courseid, $fillers=true, $category_grade_last=false, $collapsed=null, $nooutcomes=false) | |
Old syntax of class constructor. | |
inject_colspans (&$element) | |
Static recursive helper - add colspan information into categories. | |
inject_fillers (&$element, $depth) | |
Static recursive helper - makes full tree (all leafes are at the same level) | |
locate_element ($eid) | |
Parses the array in search of a given eid and returns a element object with information about the element it has found. | |
no_outcomes (&$element) | |
Static recursive helper - removes all outcomes. | |
set_grade_status_icons (array $element) | |
Sets status icons for the grade. | |
Static Public Member Functions | |
static | can_output_item ($element) |
Determines whether the grade tree item can be displayed. | |
Public Attributes | |
$context | |
$courseid | |
array | $items |
Grade items $items. | |
array | $levels |
2D array of grade items and categories $levels | |
course_modinfo | $modinfo |
Reference to modinfo for current course (for performance, to save retrieving it from courseid every time). | |
object | $top_element |
The basic representation of the tree as a hierarchical, 3-tiered array. | |
This class represents a complete tree of categories, grade_items and final grades, organises as an array primarily, but which can also be converted to other formats.
It has simple method calls with complex implementations, allowing for easy insertion, deletion and moving of items and categories within the tree.
@uses grade_structure
grade_tree::__construct | ( | $courseid, | |
$fillers = true, | |||
$category_grade_last = false, | |||
$collapsed = null, | |||
$nooutcomes = false ) |
Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item objects for the given courseid.
Full objects are instantiated. Ordering sequence is fixed if needed.
int | $courseid | The Course ID |
bool | $fillers | include fillers and colspans, make the levels var "rectangular" |
bool | $category_grade_last | category grade item is the last child |
array | $collapsed | array of collapsed categories |
bool | $nooutcomes | Whether or not outcomes should be included |
|
static |
Determines whether the grade tree item can be displayed.
This is particularly targeted for grade categories that have no total (None) when rendering the grade tree. It checks if the grade tree item is of type 'category', and makes sure that the category, or at least one of children, can be output.
array | $element | The grade category element. |
bool | True if the grade tree item can be displayed. False, otherwise. |
grade_tree::category_collapse | ( | & | $element, |
$collapsed ) |
Static recursive helper - removes items from collapsed categories.
array | &$element | The seed of the recursion |
array | $collapsed | array of collapsed categories |
void |
grade_tree::category_grade_last | ( | & | $element | ) |
Static recursive helper - makes the grade_item for category the last children.
array | &$element | The seed of the recursion |
void |
grade_tree::exporttojson | ( | $root = null, | |
$tabs = "\t" ) |
Returns a JSON representation of the grade-tree using recursion.
array | $root | The current element in the recursion. If null, starts at the top of the tree. |
string | $tabs | Tab characters used to indent the string nicely for humans to enjoy |
string |
grade_tree::exporttoxml | ( | $root = null, | |
$tabs = "\t" ) |
Returns a well-formed XML representation of the grade-tree using recursion.
array | $root | The current element in the recursion. If null, starts at the top of the tree. |
string | $tabs | The control character to use for tabs |
string\$xml |
grade_tree::fill_levels | ( | & | $levels, |
& | $element, | ||
$depth ) |
Static recursive helper - fills the levels array, useful when accessing tree elements of one level.
array | &$levels | The levels of the grade tree through which to recurse |
array | &$element | The seed of the recursion |
int | $depth | How deep are we? |
void |
|
inherited |
Returns link to the advanced grading page.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
string|null |
|
inherited |
Return calculation icon for given element.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
bool | $returnactionmenulink | return the instance of action_menu_link instead of string |
string|action_menu_link |
|
inherited |
Returns an action menu for the grade.
array | $element | Array with cell info. |
string | $mode | Mode - gradeitem or user |
grade_plugin_return | $gpr | |
moodle_url | null | $baseurl |
string |
|
inherited |
Returns a link to delete a given element.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
string|null |
|
inherited |
Returns a link to duplicate a given element.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
string|null |
|
inherited |
Returns link to edit calculation for a grade item.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
string|null |
|
inherited |
Return edit icon for give element.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
bool | $returnactionmenulink | return the instance of action_menu_link instead of string |
string|action_menu_link |
|
inherited |
Returns a link leading to the edit grade/grade item/category page.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
string|null |
|
inherited |
Returns name of element optionally with icon and link.
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. |
string | header |
|
inherited |
Returns icon of element.
array | &$element | An array representing an element in the grade_tree |
bool | $spacerifnone | return spacer if no icon found |
string | icon or spacer |
|
inherited |
Returns the string that describes the type of the element.
array | $element | An array representing an element in the grade_tree |
string | The string that describes the type of the grade element |
|
inherited |
Returns an action menu for the grade.
grade_grade | $grade | A grade_grade object |
string |
|
inherited |
Returns an action icon leading to the grade analysis page.
grade_grade | $grade |
string |
|
inherited |
Returns a link leading to the grade analysis page.
grade_grade | $grade |
string|null |
|
inherited |
Returns URL of a page that is supposed to contain detailed grade analysis.
At the moment, only activity modules are supported. The method generates link to the module's file grade.php with the parameters id (cmid), itemid, itemnumber, gradeid and userid. If the grade.php does not exist, null is returned.
moodle_url|null | URL or null if unable to construct it |
|
inherited |
Returns the grade eid - the grade may not exist yet.
grade_grade | $grade_grade | A grade_grade object |
string | eid |
|
inherited |
Return hiding icon for give element.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
bool | $returnactionmenulink | return the instance of action_menu_link instead of string |
string|action_menu_link |
|
inherited |
Returns a link with url to hide/unhide grade/grade item/grade category.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
string|null |
grade_tree::get_item | ( | $itemid | ) |
Returns a specific Grade Item.
int | $itemid | The ID of the grade_item object |
grade_item |
|
inherited |
Returns the grade_item eid.
grade_item | $grade_item | A grade_item object |
string | eid |
grade_tree::get_items | ( | ) |
Returns the array of grade items.
array |
grade_tree::get_levels | ( | ) |
Returns the array of levels.
array |
|
inherited |
Return locking icon for given element.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
string |
|
inherited |
Returns link to lock/unlock grade/grade item/grade category.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
string|null |
|
inherited |
Given a grade_tree element, returns an array of parameters used to build an icon for that element.
array | $element | An array representing an element in the grade_tree |
array |
|
inherited |
Return a reset icon for the given element.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
bool | $returnactionmenulink | return the instance of action_menu_link instead of string |
string|action_menu_link |
|
inherited |
Returns a link to reset weights for the given element.
array | $element | An array representing an element in the grade_tree |
object | $gpr | A grade_plugin_return object |
string|null |
|
inherited |
Returns link to sort grade item column.
moodle_url | $sortlink | A base link for sorting |
object | $gpr | A grade_plugin_return object |
string | $direction | Direction od sorting |
string |
grade_tree::grade_tree | ( | $courseid, | |
$fillers = true, | |||
$category_grade_last = false, | |||
$collapsed = null, | |||
$nooutcomes = false ) |
grade_tree::inject_colspans | ( | & | $element | ) |
Static recursive helper - add colspan information into categories.
array | &$element | The seed of the recursion |
int |
grade_tree::inject_fillers | ( | & | $element, |
$depth ) |
Static recursive helper - makes full tree (all leafes are at the same level)
array | &$element | The seed of the recursion |
int | $depth | How deep are we? |
int |
grade_tree::locate_element | ( | $eid | ) |
Parses the array in search of a given eid and returns a element object with information about the element it has found.
int | $eid | Gradetree Element ID |
object | element |
grade_tree::no_outcomes | ( | & | $element | ) |
Static recursive helper - removes all outcomes.
array | &$element | The seed of the recursion |
void |
|
inherited |
Sets status icons for the grade.
array | $element | array with grade item info |
string|null | status icons container HTML |
|
inherited |
Reference to modinfo for current course (for performance, to save retrieving it from courseid every time).
Not actually set except for the grade_tree type.
object grade_tree::$top_element |
The basic representation of the tree as a hierarchical, 3-tiered array.
$top_element