Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
part_of_admin_tree Interface Reference

CLASS DEFINITIONS /////////////////////////////////////////////////////////. More...

Inheritance diagram for part_of_admin_tree:
admin_externalpage admin_settingpage parentable_part_of_admin_tree admin_page_manageblocks admin_page_managefilters admin_page_managemessageoutputs admin_page_managemods admin_page_manageportfolios admin_page_manageqbehaviours admin_page_manageqtypes admin_page_managerepositories admin_page_pluginsoverview assign_admin_page_manage_assign_plugins core_admin\local\externalpage\accesscallback theme_boost_admin_settingspage_tabs admin_category

Public Member Functions

 check_access ()
 Verifies current user's access to this part_of_admin_tree.
 
 is_hidden ()
 Mostly useful for removing of some parts of the tree in admin tree block.
 
 locate ($name)
 Finds a named part_of_admin_tree.
 
 prune ($name)
 Removes named part_of_admin_tree.
 
 search ($query)
 Search using query.
 
 show_save ()
 Show we display Save button at the page bottom?
 

Detailed Description

CLASS DEFINITIONS /////////////////////////////////////////////////////////.

Interface for anything appearing in the admin tree

The interface that is implemented by anything that appears in the admin tree block. It forces inheriting classes to define a method for checking user permissions and methods for finding something in the admin tree.

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

Member Function Documentation

◆ check_access()

part_of_admin_tree::check_access ( )

Verifies current user's access to this part_of_admin_tree.

Used to check if the current user has access to this part of the admin tree or not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree, then this method is usually just a call to has_capability() in the site context.

If a class inherits parentable_part_of_admin_tree, this method should return the logical OR of the return of check_access() on all child objects.

Return values
boolTrue if the user has access, false if she doesn't.

Implemented in admin_category, admin_externalpage, admin_settingpage, and core_admin\local\externalpage\accesscallback.

◆ is_hidden()

part_of_admin_tree::is_hidden ( )

Mostly useful for removing of some parts of the tree in admin tree block.

Return values
Trueis hidden from normal list view

Implemented in admin_category, admin_externalpage, and admin_settingpage.

◆ locate()

part_of_admin_tree::locate ( $name)

Finds a named part_of_admin_tree.

Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree, then this function should only check if $this->name matches $name. If it does, it should return a reference to $this, otherwise, it should return a reference to NULL.

If a class inherits parentable_part_of_admin_tree, this method should be called recursively on all child objects (assuming, of course, the parent object's name doesn't match the search criterion).

Parameters
string$nameThe internal name of the part_of_admin_tree we're searching for.
Return values
mixedAn object reference or a NULL reference.

◆ prune()

part_of_admin_tree::prune ( $name)

Removes named part_of_admin_tree.

Parameters
string$nameThe internal name of the part_of_admin_tree we want to remove.
Return values
boolsuccess.

Implemented in admin_category, admin_externalpage, and admin_settingpage.

◆ search()

◆ show_save()

part_of_admin_tree::show_save ( )

Show we display Save button at the page bottom?

Return values
bool

Implemented in admin_category, admin_externalpage, and admin_settingpage.


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