core_user\output\myprofile\tree Class Reference

Defines my profile page navigation tree. More...

Inheritance diagram for core_user\output\myprofile\tree:

Public Member Functions
	__get ($prop)
	Magic get method. More...
	add_category (category $cat)
	Add a category to the tree. More...
	add_node (node $node)
	Add a node to the tree. More...
	sort_categories ()
	Sort categories and nodes. More...

Protected Member Functions
	attach_nodes_to_categories ()
	Attach various nodes to their respective categories. More...
	find_categories_after ($category)
	Find all category nodes that should be displayed after a given a category node. More...

Detailed Description

Defines my profile page navigation tree.

Since

Moodle 2.9

Copyright

2015 onwards Ankit Agarwal

License

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

Member Function Documentation

__get()

core_user\output\myprofile\tree::__get

(

$prop

)

Magic get method.

Parameters

string

$prop

property to get.

Return values

mixed

Exceptions

coding_exception

add_category()

core_user\output\myprofile\tree::add_category

(

category

$cat

)

Add a category to the tree.

Parameters

category

$cat

category object.

Exceptions

coding_exception

add_node()

core_user\output\myprofile\tree::add_node

(

node

$node

)

Add a node to the tree.

Parameters

node

$node

node object.

Exceptions

coding_exception

attach_nodes_to_categories()

core_user\output\myprofile\tree::attach_nodes_to_categories ( )

protected

Attach various nodes to their respective categories.

Exceptions

coding_exception

find_categories_after()

core_user\output\myprofile\tree::find_categories_after (   $category )

protected

Find all category nodes that should be displayed after a given a category node.

Parameters

category

$category

category object

Return values

category[]

array of category objects

Exceptions

coding_exception

sort_categories()

core_user\output\myprofile\tree::sort_categories

(

)

Sort categories and nodes.

Builds the tree structure that would be displayed to the user.

Exceptions

coding_exception

---

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

• user/classes/output/myprofile/tree.php