assign_admin_page_manage_assign_plugins Class Reference

Admin external page that displays a list of the installed submission plugins. More...

Inheritance diagram for assign_admin_page_manage_assign_plugins:

Public Member Functions
	__construct ($subtype)
	The constructor - calls parent constructor. More...
	check_access ()
	Determines if the current user has access to this external page based on $this->req_capability. More...
	is_hidden ()
	Is this external page hidden in admin tree block? More...
	locate ($name)
	Finds a named part_of_admin_tree. More...
	locate ($name, $findpath=false)
	Returns a reference to the part_of_admin_tree object with internal name $name. More...
	prune ($name)
	This function always returns false, required function by interface. More...
	search ($query)
	Search plugins for the specified string. 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
	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. More...
array	$visiblepath
	list of visible names of page parents

Detailed Description

Admin external page that displays a list of the installed submission plugins.

Copyright

2012 NetSpot http://www.netspot.com.au

License

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

Constructor & Destructor Documentation

__construct()

assign_admin_page_manage_assign_plugins::__construct

(

$subtype

)

The constructor - calls parent constructor.

Parameters

string

$subtype

Member Function Documentation

check_access()

admin_externalpage::check_access ( )

inherited

Determines if the current user has access to this external page based on $this->req_capability.

Return values

bool	True if user has access, false otherwise.

Implements part_of_admin_tree.

is_hidden()

admin_externalpage::is_hidden ( )

inherited

Is this external 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_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.

prune()

admin_externalpage::prune (   $name )

inherited

This function always returns false, required function by interface.

Parameters

string

$name

Return values

false

Implements part_of_admin_tree.

search()

assign_admin_page_manage_assign_plugins::search

(

$query

)

Search plugins for the specified string.

Parameters

string

$query

The string to search for

Return values

array

Reimplemented from admin_externalpage.

show_save()

admin_externalpage::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_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:

• mod/assign/adminlib.php