admin_settingpage Class Reference

Inheritance diagram for admin_settingpage:

Collaboration diagram for admin_settingpage:

Public Member Functions
	__construct ($name, $visiblename, $req_capability='moodle/site:config', $hidden=false, $context=NULL)
	locate ($name, $findpath=false)
	search ($query)
	prune ($name)
	add ($setting)
	check_access ()
	output_html ()
	is_hidden ()
	show_save ()
Data Fields
	$name
	$visiblename
	$settings
	$req_capability
	$context
	$hidden
	$path
	$visiblepath

---

Detailed Description

Used to group a number of admin_setting objects into a page and add them to the admin tree.

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

Definition at line 1198 of file adminlib.php.

---

Constructor & Destructor Documentation

__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.

Definition at line 1234 of file adminlib.php.

---

Member Function Documentation

add

(

$

setting

)

adds an admin_setting to this admin_settingpage

not the same as add for admin_category. adds an admin_setting to this admin_settingpage. settings appear (on the settingpage) in the order in which they're added n.b. each admin_setting in an admin_settingpage must have a unique internal name

Parameters:

object

$setting

is the admin_setting object you want to add

Returns:

bool true if successful, false if not

Definition at line 1326 of file adminlib.php.

Here is the call graph for this function:

check_access

(

)

see admin_externalpage

Returns:

bool Returns true for yes false for no

Implements part_of_admin_tree.

Definition at line 1341 of file adminlib.php.

Here is the call graph for this function:

is_hidden

(

)

Is this settings page hidden in admin tree block?

Returns:

bool True if hidden

Implements part_of_admin_tree.

Definition at line 1378 of file adminlib.php.

locate	(	$	name,
		$	findpath = false
	)

see admin_category

Parameters:

string	$name
bool	$findpath

Returns:

mixed Object (this) if name == this->name, else returns null

Definition at line 1254 of file adminlib.php.

output_html

(

)

outputs this page as html in a table (suitable for inclusion in an admin pagetype)

Returns:

string Returns an XHTML string

Definition at line 1356 of file adminlib.php.

Here is the call graph for this function:

prune

(

$

name

)

This function always returns false, required by interface

Parameters:

string

$name

Returns:

bool Always false

Implements part_of_admin_tree.

Definition at line 1313 of file adminlib.php.

search

(

$

query

)

Search string in settings page.

Parameters:

string

$query

Returns:

array

Implements part_of_admin_tree.

Definition at line 1273 of file adminlib.php.

Here is the call graph for this function:

show_save

(

)

Show we display Save button at the page bottom?

Returns:

bool

Implements part_of_admin_tree.

Definition at line 1386 of file adminlib.php.

---

Field Documentation

$context

Definition at line 1213 of file adminlib.php.

$hidden

Definition at line 1216 of file adminlib.php.

$name

Definition at line 1201 of file adminlib.php.

$path

Definition at line 1219 of file adminlib.php.

$req_capability

Definition at line 1210 of file adminlib.php.

$settings

Definition at line 1207 of file adminlib.php.

$visiblename

Definition at line 1204 of file adminlib.php.

$visiblepath

Definition at line 1222 of file adminlib.php.

---

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

• C:/xampp/htdocs/moodle/lib/adminlib.php