Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
core\check\environment\publicpaths Class Reference

Check the public access of various paths. More...

Inheritance diagram for core\check\environment\publicpaths:
core\check\check

Public Member Functions

 get_action_link ()
 Link to the dev docs for more info.
 
 get_component ()
 Get the frankenstyle component name.
 
 get_id ()
 Get the check's id.
 
 get_name ()
 Get the short check name.
 
 get_pathsets ()
 Returns a list of test urls and metadata.
 
 get_ref ()
 Get the check reference.
 
 get_result ()
 Return result.
 
 set_component (string $component)
 Get the frankenstyle component name.
 

Protected Attributes

string $component = ''
 $component - The component / plugin this task belongs to.
 

Detailed Description

Check the public access of various paths.

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

Member Function Documentation

◆ get_action_link()

core\check\environment\publicpaths::get_action_link ( )

Link to the dev docs for more info.

Return values
action_link|null

Reimplemented from core\check\check.

◆ get_component()

core\check\check::get_component ( )
inherited

Get the frankenstyle component name.

Return values
string

◆ get_id()

core\check\check::get_id ( )
inherited

Get the check's id.

This defaults to the base name of the class which is ok in the most cases but if you have a check which can have multiple instances then you should override this to be unique.

Return values
stringmust be unique within a component

◆ get_name()

core\check\environment\publicpaths::get_name ( )

Get the short check name.

Return values
string

Reimplemented from core\check\check.

◆ get_ref()

core\check\check::get_ref ( )
inherited

Get the check reference.

Return values
stringmust be globally unique

◆ get_result()

core\check\environment\publicpaths::get_result ( )

Return result.

Return values
result

Reimplemented from core\check\check.

◆ set_component()

core\check\check::set_component ( string $component)
inherited

Get the frankenstyle component name.

Parameters
string$componentname

Member Data Documentation

◆ $component

string core\check\check::$component = ''
protectedinherited

$component - The component / plugin this task belongs to.

This can be autopopulated by the check manager. Otherwise, it is dynamically determined by get_component().


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