Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
grade_tree Class Reference

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...

Inheritance diagram for grade_tree:
grade_structure

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. More...
 
 category_collapse (&$element, $collapsed)
 Static recursive helper - removes items from collapsed categories. More...
 
 category_grade_last (&$element)
 Static recursive helper - makes the grade_item for category the last children. More...
 
 exporttojson ($root=null, $tabs="\t")
 Returns a JSON representation of the grade-tree using recursion. More...
 
 exporttoxml ($root=null, $tabs="\t")
 Returns a well-formed XML representation of the grade-tree using recursion. More...
 
 fill_levels (&$levels, &$element, $depth)
 Static recursive helper - fills the levels array, useful when accessing tree elements of one level. More...
 
 get_calculation_icon ($element, $gpr, $returnactionmenulink=false)
 Return calculation icon for given element. More...
 
 get_edit_icon ($element, $gpr, $returnactionmenulink=false)
 Return edit icon for give element. More...
 
 get_element_header (&$element, $withlink=false, $icon=true, $spacerifnone=false, $withdescription=false, $fulltotal=false)
 Returns name of element optionally with icon and link. More...
 
 get_element_icon (&$element, $spacerifnone=false)
 Returns icon of element. More...
 
 get_grade_analysis_icon (grade_grade $grade)
 Returns an action icon leading to the grade analysis page. More...
 
 get_grade_analysis_url (grade_grade $grade)
 Returns URL of a page that is supposed to contain detailed grade analysis. More...
 
 get_grade_eid ($grade_grade)
 Returns the grade eid - the grade may not exist yet. More...
 
 get_hiding_icon ($element, $gpr, $returnactionmenulink=false)
 Return hiding icon for give element. More...
 
 get_item ($itemid)
 Returns a specific Grade Item. More...
 
 get_item_eid ($grade_item)
 Returns the grade_item eid. More...
 
 get_items ()
 Returns the array of grade items. More...
 
 get_levels ()
 Returns the array of levels. More...
 
 get_locking_icon ($element, $gpr)
 Return locking icon for given element. More...
 
 get_params_for_iconstr ($element)
 Given a grade_tree element, returns an array of parameters used to build an icon for that element. More...
 
 get_reset_icon ($element, $gpr, $returnactionmenulink=false)
 Return a reset icon for the given element. More...
 
 grade_tree ($courseid, $fillers=true, $category_grade_last=false, $collapsed=null, $nooutcomes=false)
 Old syntax of class constructor. More...
 
 inject_colspans (&$element)
 Static recursive helper - add colspan information into categories. More...
 
 inject_fillers (&$element, $depth)
 Static recursive helper - makes full tree (all leafes are at the same level) More...
 
 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. More...
 
 no_outcomes (&$element)
 Static recursive helper - removes all outcomes. More...
 

Static Public Member Functions

static can_output_item ($element)
 Determines whether the grade tree item can be displayed. More...
 

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). More...
 
object $top_element
 The basic representation of the tree as a hierarchical, 3-tiered array. More...
 

Detailed Description

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

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

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.

Parameters
int$courseidThe Course ID
bool$fillersinclude fillers and colspans, make the levels var "rectangular"
bool$category_grade_lastcategory grade item is the last child
array$collapsedarray of collapsed categories
bool$nooutcomesWhether or not outcomes should be included

Member Function Documentation

◆ can_output_item()

static grade_tree::can_output_item (   $element)
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.

Parameters
array$elementThe grade category element.
Return values
boolTrue if the grade tree item can be displayed. False, otherwise.

◆ category_collapse()

grade_tree::category_collapse ( $element,
  $collapsed 
)

Static recursive helper - removes items from collapsed categories.

Parameters
array&$elementThe seed of the recursion
array$collapsedarray of collapsed categories
Return values
void

◆ category_grade_last()

grade_tree::category_grade_last ( $element)

Static recursive helper - makes the grade_item for category the last children.

Parameters
array&$elementThe seed of the recursion
Return values
void

◆ exporttojson()

grade_tree::exporttojson (   $root = null,
  $tabs = "\t" 
)

Returns a JSON representation of the grade-tree using recursion.

Parameters
array$rootThe current element in the recursion. If null, starts at the top of the tree.
string$tabsTab characters used to indent the string nicely for humans to enjoy
Return values
string

◆ exporttoxml()

grade_tree::exporttoxml (   $root = null,
  $tabs = "\t" 
)

Returns a well-formed XML representation of the grade-tree using recursion.

Parameters
array$rootThe current element in the recursion. If null, starts at the top of the tree.
string$tabsThe control character to use for tabs
Return values
string::$xml

◆ fill_levels()

grade_tree::fill_levels ( $levels,
$element,
  $depth 
)

Static recursive helper - fills the levels array, useful when accessing tree elements of one level.

Parameters
array&$levelsThe levels of the grade tree through which to recurse
array&$elementThe seed of the recursion
int$depthHow deep are we?
Return values
void

◆ get_calculation_icon()

grade_structure::get_calculation_icon (   $element,
  $gpr,
  $returnactionmenulink = false 
)
inherited

Return calculation icon for given element.

Parameters
array$elementAn array representing an element in the grade_tree
object$gprA grade_plugin_return object
bool$returnactionmenulinkreturn the instance of action_menu_link instead of string
Return values
string|action_menu_link

◆ get_edit_icon()

grade_structure::get_edit_icon (   $element,
  $gpr,
  $returnactionmenulink = false 
)
inherited

Return edit icon for give element.

Parameters
array$elementAn array representing an element in the grade_tree
object$gprA grade_plugin_return object
bool$returnactionmenulinkreturn the instance of action_menu_link instead of string
Return values
string|action_menu_link

◆ get_element_header()

grade_structure::get_element_header ( $element,
  $withlink = false,
  $icon = true,
  $spacerifnone = false,
  $withdescription = false,
  $fulltotal = false 
)
inherited

Returns name of element optionally with icon and link.

Parameters
array&$elementAn array representing an element in the grade_tree
bool$withlinkWhether or not this header has a link
bool$iconWhether or not to display an icon with this header
bool$spacerifnonereturn spacer if no icon found
bool$withdescriptionShow description if defined by this item.
bool$fulltotalIf the item is a category total, returns $categoryname."total" instead of "Category total" or "Course total"
Return values
stringheader

◆ get_element_icon()

grade_structure::get_element_icon ( $element,
  $spacerifnone = false 
)
inherited

Returns icon of element.

Parameters
array&$elementAn array representing an element in the grade_tree
bool$spacerifnonereturn spacer if no icon found
Return values
stringicon or spacer

◆ get_grade_analysis_icon()

grade_structure::get_grade_analysis_icon ( grade_grade  $grade)
inherited

Returns an action icon leading to the grade analysis page.

Parameters
grade_grade$grade
Return values
string

◆ get_grade_analysis_url()

grade_structure::get_grade_analysis_url ( grade_grade  $grade)
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.

Return values
moodle_url|nullURL or null if unable to construct it

◆ get_grade_eid()

grade_structure::get_grade_eid (   $grade_grade)
inherited

Returns the grade eid - the grade may not exist yet.

Parameters
grade_grade$grade_gradeA grade_grade object
Return values
stringeid

◆ get_hiding_icon()

grade_structure::get_hiding_icon (   $element,
  $gpr,
  $returnactionmenulink = false 
)
inherited

Return hiding icon for give element.

Parameters
array$elementAn array representing an element in the grade_tree
object$gprA grade_plugin_return object
bool$returnactionmenulinkreturn the instance of action_menu_link instead of string
Return values
string|action_menu_link

◆ get_item()

grade_tree::get_item (   $itemid)

Returns a specific Grade Item.

Parameters
int$itemidThe ID of the grade_item object
Return values
grade_item

◆ get_item_eid()

grade_structure::get_item_eid (   $grade_item)
inherited

Returns the grade_item eid.

Parameters
grade_item$grade_itemA grade_item object
Return values
stringeid

◆ get_items()

grade_tree::get_items ( )

Returns the array of grade items.

Return values
array

◆ get_levels()

grade_tree::get_levels ( )

Returns the array of levels.

Return values
array

◆ get_locking_icon()

grade_structure::get_locking_icon (   $element,
  $gpr 
)
inherited

Return locking icon for given element.

Parameters
array$elementAn array representing an element in the grade_tree
object$gprA grade_plugin_return object
Return values
string

◆ get_params_for_iconstr()

grade_structure::get_params_for_iconstr (   $element)
inherited

Given a grade_tree element, returns an array of parameters used to build an icon for that element.

Parameters
array$elementAn array representing an element in the grade_tree
Return values
array

◆ get_reset_icon()

grade_structure::get_reset_icon (   $element,
  $gpr,
  $returnactionmenulink = false 
)
inherited

Return a reset icon for the given element.

Parameters
array$elementAn array representing an element in the grade_tree
object$gprA grade_plugin_return object
bool$returnactionmenulinkreturn the instance of action_menu_link instead of string
Return values
string|action_menu_link

◆ grade_tree()

grade_tree::grade_tree (   $courseid,
  $fillers = true,
  $category_grade_last = false,
  $collapsed = null,
  $nooutcomes = false 
)

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated:
since Moodle 3.1

◆ inject_colspans()

grade_tree::inject_colspans ( $element)

Static recursive helper - add colspan information into categories.

Parameters
array&$elementThe seed of the recursion
Return values
int

◆ inject_fillers()

grade_tree::inject_fillers ( $element,
  $depth 
)

Static recursive helper - makes full tree (all leafes are at the same level)

Parameters
array&$elementThe seed of the recursion
int$depthHow deep are we?
Return values
int

◆ locate_element()

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.

Parameters
int$eidGradetree Element ID
Return values
objectelement

◆ no_outcomes()

grade_tree::no_outcomes ( $element)

Static recursive helper - removes all outcomes.

Parameters
array&$elementThe seed of the recursion
Return values
void

Member Data Documentation

◆ $modinfo

course_modinfo grade_structure::$modinfo
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.

◆ $top_element

object grade_tree::$top_element

The basic representation of the tree as a hierarchical, 3-tiered array.

$top_element


The documentation for this class was generated from the following file: