Used to group a number of admin_setting objects into a page and add them to the admin tree.
More...
|
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 |
| string of paths or array of strings of paths
|
|
array | $req_capability |
| The role capability/permission a user must have to access this external page.
|
|
mixed | $settings |
| An array of admin_setting objects that are part of this setting page.
|
|
string | $visiblename |
| The displayed name for this external page.
|
|
array | $visiblepath |
| list of visible names of page parents
|
|
Used to group a number of admin_setting objects into a page and add them to the admin tree.
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
admin_settingpage::__construct |
( |
| $name, |
|
|
| $visiblename, |
|
|
| $req_capability = 'moodle/site:config', |
|
|
| $hidden = false, |
|
|
| $context = NULL ) |
see admin_settingpage for details of this function
- Parameters
-
string | $name | The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects. |
string | $visiblename | The displayed name for this external page. Usually obtained through get_string(). |
mixed | $req_capability | The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'. |
boolean | $hidden | Is this external page hidden in admin tree block? Default false. |
stdClass | $context | The context the page relates to. Not sure what happens if you specify something other than system or front page. Defaults to system. |
◆ add()
admin_settingpage::add |
( |
| $setting | ) |
|
◆ check_access()
admin_settingpage::check_access |
( |
| ) |
|
◆ get_dependencies_for_javascript()
admin_settingpage::get_dependencies_for_javascript |
( |
| ) |
|
Format the setting show/hide conditions ready to initialise the page javascript.
- Return values
-
◆ get_settings_page_url()
admin_settingpage::get_settings_page_url |
( |
| ) |
|
◆ has_dependencies()
admin_settingpage::has_dependencies |
( |
| ) |
|
Should any of the settings on this page be shown / hidden based on conditions?
- Return values
-
◆ hide_if()
admin_settingpage::hide_if |
( |
| $settingname, |
|
|
| $dependenton, |
|
|
| $condition = 'notchecked', |
|
|
| $value = '1' ) |
Hide the named setting if the specified condition is matched.
- Parameters
-
string | $settingname | |
string | $dependenton | |
string | $condition | |
string | $value | |
◆ is_hidden()
admin_settingpage::is_hidden |
( |
| ) |
|
Is this settings page hidden in admin tree block?
- Return values
-
Implements part_of_admin_tree.
◆ locate() [1/2]
admin_settingpage::locate |
( |
| $name, |
|
|
| $findpath = false ) |
see admin_category
- Parameters
-
string | $name | |
bool | $findpath | |
- Return values
-
mixed | Object (this) if name == this->name, else returns 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. |
◆ output_html()
admin_settingpage::output_html |
( |
| ) |
|
outputs this page as html in a table (suitable for inclusion in an admin pagetype)
- Return values
-
string | Returns an XHTML string |
Reimplemented in theme_boost_admin_settingspage_tabs.
◆ prune()
admin_settingpage::prune |
( |
| $name | ) |
|
This function always returns false, required by interface.
- Parameters
-
- Return values
-
Implements part_of_admin_tree.
◆ search()
admin_settingpage::search |
( |
| $query | ) |
|
◆ show_save()
admin_settingpage::show_save |
( |
| ) |
|
Show we display Save button at the page bottom?
- Return values
-
Implements part_of_admin_tree.
◆ $name
string admin_settingpage::$name |
An internal name for this external page.
Must be unique amongst ALL part_of_admin_tree objects
◆ $visiblename
string admin_settingpage::$visiblename |
The displayed name for this external page.
Usually obtained through get_string().
The documentation for this class was generated from the following file: