grade_structure Class Reference

Inheritance diagram for grade_structure:

Public Member Functions
	get_element_icon (&$element, $spacerifnone=false)
	get_element_header (&$element, $withlink=false, $icon=true, $spacerifnone=false)
	get_grade_analysis_icon (grade_grade $grade)
	get_grade_eid ($grade_grade)
	get_item_eid ($grade_item)
	get_params_for_iconstr ($element)
	get_edit_icon ($element, $gpr)
	get_hiding_icon ($element, $gpr)
	get_locking_icon ($element, $gpr)
	get_calculation_icon ($element, $gpr)
Data Fields
	$context
	$courseid
	$modinfo
	$items

---

Detailed Description

Definition at line 1007 of file lib.php.

---

Member Function Documentation

get_calculation_icon	(	$	element,
		$	gpr
	)

Return calculation icon for given element

Parameters:

array	$element	An array representing an element in the grade_tree
object	$gpr	A grade_plugin_return object

Returns:

string

Definition at line 1522 of file lib.php.

Here is the call graph for this function:

get_edit_icon	(	$	element,
		$	gpr
	)

Return edit icon for give element

Parameters:

array	$element	An array representing an element in the grade_tree
object	$gpr	A grade_plugin_return object

Returns:

string

Definition at line 1344 of file lib.php.

Here is the call graph for this function:

get_element_header	(	&$	element,
		$	withlink = false,
		$	icon = true,
		$	spacerifnone = false
	)

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

Returns:

string header

Definition at line 1121 of file lib.php.

Here is the call graph for this function:

get_element_icon	(	&$	element,
		$	spacerifnone = false
	)

Returns icon of element

Parameters:

array	&$element	An array representing an element in the grade_tree
bool	$spacerifnone	return spacer if no icon found

Returns:

string icon or spacer

Definition at line 1033 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_grade_analysis_icon

(

grade_grade $

grade

)

Returns an action icon leading to the grade analysis page

Parameters:

grade_grade

$grade

Returns:

string

Definition at line 1265 of file lib.php.

get_grade_eid

(

$

grade_grade

)

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

Parameters:

grade_grade

$grade_grade

A grade_grade object

Returns:

string eid

Definition at line 1284 of file lib.php.

get_hiding_icon	(	$	element,
		$	gpr
	)

Return hiding icon for give element

Parameters:

array	$element	An array representing an element in the grade_tree
object	$gpr	A grade_plugin_return object

Returns:

string

Definition at line 1420 of file lib.php.

Here is the call graph for this function:

get_item_eid

(

$

grade_item

)

Returns the grade_item eid

Parameters:

grade_item

$grade_item

A grade_item object

Returns:

string eid

Definition at line 1297 of file lib.php.

get_locking_icon	(	$	element,
		$	gpr
	)

Return locking icon for given element

Parameters:

array	$element	An array representing an element in the grade_tree
object	$gpr	A grade_plugin_return object

Returns:

string

Definition at line 1466 of file lib.php.

Here is the call graph for this function:

get_params_for_iconstr

(

$

element

)

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

Parameters:

array

$element

An array representing an element in the grade_tree

Returns:

array

Definition at line 1309 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

$context

Definition at line 1008 of file lib.php.

$courseid

Definition at line 1010 of file lib.php.

$items

1D array of grade items only

Reimplemented in grade_tree.

Definition at line 1023 of file lib.php.

$modinfo

Definition at line 1018 of file lib.php.

---

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

• C:/xampp/htdocs/moodle/grade/lib.php