|
Moodle
2.2.1
http://www.collinsharper.com
|
|
Moodle
2.2.1
http://www.collinsharper.com
|
CLASS DEFINITIONS /////////////////////////////////////////////////////////. More...
Public Member Functions | |
| locate ($name) | |
| prune ($name) | |
| search ($query) | |
| check_access () | |
| is_hidden () | |
| show_save () | |
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.
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Definition at line 676 of file adminlib.php.
| 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.
Implemented in admin_settingpage, admin_externalpage, and admin_category.
| is_hidden | ( | ) |
Mostly useful for removing of some parts of the tree in admin tree block.
Implemented in admin_settingpage, admin_externalpage, and admin_category.
| 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).
| string | $name | The internal name of the part_of_admin_tree we're searching for. |
| prune | ( | $ | name | ) |
Removes named part_of_admin_tree.
| string | $name | The internal name of the part_of_admin_tree we want to remove. |
Implemented in admin_settingpage, admin_externalpage, and admin_category.
| search | ( | $ | query | ) |
Search using query
| string | $query |
Implemented in admin_page_managefilters, admin_page_managerepositories, admin_page_manageportfolios, admin_page_manageqtypes, admin_page_manageqbehaviours, admin_page_managemessageoutputs, admin_page_manageblocks, admin_page_managemods, admin_settingpage, admin_externalpage, and admin_category.
| show_save | ( | ) |
Show we display Save button at the page bottom?
Implemented in admin_settingpage, admin_externalpage, and admin_category.
1.7.6.1 
