General plugins manager.
More...
|
| __construct () |
| Sets basic information about the external page.
|
|
| check_access () |
| Determines if the current user has access to this external page based on $this->req_capability.
|
|
| get_settings_page_url () |
| Get the URL to view this settings page.
|
|
| is_hidden () |
| Is this external page hidden in admin tree block?
|
|
| locate ($name, $findpath=false) |
| Returns a reference to the part_of_admin_tree object with internal name $name.
|
|
| locate ($name) |
| Finds a named part_of_admin_tree.
|
|
| prune ($name) |
| This function always returns false, required function by interface.
|
|
| search ($query) |
| Search using query.
|
|
| show_save () |
| Show we display Save button at the page bottom?
|
|
|
object | $context |
| The context in which capability/permission should be checked, default is site context.
|
|
bool | $hidden |
| hidden in admin tree block.
|
|
string | $name |
| An internal name for this external page.
|
|
mixed | $path |
| either string or array of string
|
|
array | $req_capability |
| The role capability/permission a user must have to access this external page.
|
|
string | $url |
| The external URL that we should link to when someone requests this external page.
|
|
string | $visiblename |
| The displayed name for this external page.
|
|
array | $visiblepath |
| list of visible names of page parents
|
|
◆ check_access()
admin_externalpage::check_access |
( |
| ) |
|
|
inherited |
◆ get_settings_page_url()
admin_externalpage::get_settings_page_url |
( |
| ) |
|
|
inherited |
◆ is_hidden()
admin_externalpage::is_hidden |
( |
| ) |
|
|
inherited |
Is this external page hidden in admin tree block?
- Return values
-
Implements part_of_admin_tree.
◆ locate() [1/2]
admin_externalpage::locate |
( |
| $name, |
|
|
| $findpath = false ) |
|
inherited |
Returns a reference to the part_of_admin_tree object with internal name $name.
- Parameters
-
string | $name | The internal name of the object we want. |
bool | $findpath | defaults to false |
- Return values
-
mixed | A reference to the object with internal name $name if found, otherwise a reference to NULL. |
◆ locate() [2/2]
part_of_admin_tree::locate |
( |
| $name | ) |
|
|
inherited |
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
-
- Return values
-
mixed | An object reference or a NULL reference. |
◆ prune()
admin_externalpage::prune |
( |
| $name | ) |
|
|
inherited |
This function always returns false, required function by interface.
- Parameters
-
- Return values
-
Implements part_of_admin_tree.
◆ search()
admin_externalpage::search |
( |
| $query | ) |
|
|
inherited |
◆ show_save()
admin_externalpage::show_save |
( |
| ) |
|
|
inherited |
Show we display Save button at the page bottom?
- Return values
-
Implements part_of_admin_tree.
◆ $name
string admin_externalpage::$name |
|
inherited |
An internal name for this external page.
Must be unique amongst ALL part_of_admin_tree objects
◆ $visiblename
string admin_externalpage::$visiblename |
|
inherited |
The displayed name for this external page.
Usually obtained through get_string().
The documentation for this class was generated from the following file: