Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
admin_page_managerepositories Class Reference
Inheritance diagram for admin_page_managerepositories:
admin_externalpage part_of_admin_tree

Public Member Functions

 __construct ()
 Calls parent::__construct with specific arguments.
 
 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)
 Searches page 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
 

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
boolTrue 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
boolTrue 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$nameThe internal name of the part_of_admin_tree we're searching for.
Return values
mixedAn 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$nameThe internal name of the object we want.
bool$findpathdefaults to false
Return values
mixedA 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()

admin_page_managerepositories::search (   $query)

Searches page for the specified string.

Parameters
string$queryThe string to search for
Return values
boolTrue if it is found on this page

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: