theme_boost_admin_settingspage_tabs Class Reference

Inheritance diagram for theme_boost_admin_settingspage_tabs:

Public Member Functions
	add ($tab)
	adds an admin_setting to this admin_settingpage More...
	add_tab (admin_settingpage $tab)
	Add a tab. More...
	check_access ()
	see admin_externalpage More...
	get_dependencies_for_javascript ()
	Format the setting show/hide conditions ready to initialise the page javascript. More...
	get_tabs ()
	Get tabs. More...
	has_dependencies ()
	Should any of the settings on this page be shown / hidden based on conditions? More...
	hide_if ($settingname, $dependenton, $condition='notchecked', $value='1')
	Hide the named setting if the specified condition is matched. More...
	is_hidden ()
	Is this settings page hidden in admin tree block? More...
	locate ($name)
	Finds a named part_of_admin_tree. More...
	locate ($name, $findpath=false)
	see admin_category More...
	output_html ()
	Generate the HTML output. More...
	prune ($name)
	This function always returns false, required by interface. More...
	search ($query)
	Search string in settings page. More...
	show_save ()
	Show we display Save button at the page bottom? More...

Public Attributes
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. More...
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. More...
array	$visiblepath
	list of visible names of page parents

Protected Attributes
admin_settingdependency[]	$dependencies = []
	list of settings to hide when certain conditions are met
The	$tabs = array()
	tabs

Detailed Description

Copyright

2016 Ryan Wyllie

License

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

Member Function Documentation

add()

theme_boost_admin_settingspage_tabs::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

Return values

bool	true if successful, false if not

Reimplemented from admin_settingpage.

add_tab()

theme_boost_admin_settingspage_tabs::add_tab

(

admin_settingpage

$tab

)

Add a tab.

Parameters

admin_settingpage

$tab

A tab.

check_access()

admin_settingpage::check_access ( )

inherited

see admin_externalpage

Return values

bool	Returns true for yes false for no

Implements part_of_admin_tree.

get_dependencies_for_javascript()

admin_settingpage::get_dependencies_for_javascript ( )

inherited

Format the setting show/hide conditions ready to initialise the page javascript.

Return values

array

get_tabs()

theme_boost_admin_settingspage_tabs::get_tabs

(

)

Get tabs.

Return values

array

has_dependencies()

admin_settingpage::has_dependencies ( )

inherited

Should any of the settings on this page be shown / hidden based on conditions?

Return values

bool

hide_if()

admin_settingpage::hide_if (   $settingname,   $dependenton,   $condition = 'notchecked',   $value = '1'  )

inherited

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 ( )

inherited

Is this settings page hidden in admin tree block?

Return values

bool	True if hidden

Implements part_of_admin_tree.

locate() [1/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

string

$name

The internal name of the part_of_admin_tree we're searching for.

Return values

mixed

An object reference or a NULL reference.

locate() [2/2]

admin_settingpage::locate (   $name,   $findpath = false  )

inherited

see admin_category

Parameters

string	$name
bool	$findpath

Return values

mixed

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

output_html()

theme_boost_admin_settingspage_tabs::output_html

(

)

Generate the HTML output.

Return values

string

Reimplemented from admin_settingpage.

prune()

admin_settingpage::prune (   $name )

inherited

This function always returns false, required by interface.

Parameters

string

$name

Return values

bool	Always false

Implements part_of_admin_tree.

search()

admin_settingpage::search (   $query )

inherited

Search string in settings page.

Parameters

string

$query

Return values

array

Implements part_of_admin_tree.

show_save()

admin_settingpage::show_save ( )

inherited

Show we display Save button at the page bottom?

Return values

bool

Implements part_of_admin_tree.

Member Data Documentation

$name

string admin_settingpage::$name

inherited

An internal name for this external page.

Must be unique amongst ALL part_of_admin_tree objects

$visiblename

string admin_settingpage::$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:

• theme/boost/classes/admin_settingspage_tabs.php