Moodle  2.2.1
http://www.collinsharper.com
parentable_part_of_admin_tree Interface Reference
Inheritance diagram for parentable_part_of_admin_tree:
Collaboration diagram for parentable_part_of_admin_tree:

Public Member Functions

 add ($destinationname, $something)

Detailed Description

Interface implemented by any part_of_admin_tree that has children.

The interface implemented by any part_of_admin_tree that can be a parent to other part_of_admin_tree's. (For now, this only includes admin_category.) Apart from ensuring part_of_admin_tree compliancy, it also ensures inheriting methods include an add method for adding other part_of_admin_tree objects as children.

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

Definition at line 749 of file adminlib.php.


Member Function Documentation

add ( destinationname,
something 
)

Adds a part_of_admin_tree object to the admin tree.

Used to add a part_of_admin_tree object to this object or a child of this object. $something should only be added if $destinationname matches $this->name. If it doesn't, add should be called on child objects that are also parentable_part_of_admin_tree's.

Parameters:
string$destinationnameThe internal name of the new parent for $something.
part_of_admin_tree$somethingThe object to be added.
Returns:
bool True on success, false on failure.

Implemented in admin_category.


The documentation for this interface was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations