core\check\external\get_result_admintree Class Reference

Inheritance diagram for core\check\external\get_result_admintree:

Static Public Member Functions
static	execute (string $admintreeid, string $settingname, bool $includedetails, admin_root $admintree=null)
	Gets the result of the check and returns it.
static	execute_parameters ()
	Defines parameters.
static	execute_returns ()
	Defines return structure.

Detailed Description

Copyright

2023 Matthew Hilton matth.nosp@m.ewhi.nosp@m.lton@.nosp@m.cata.nosp@m.lyst-.nosp@m.au.n.nosp@m.et

License

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

Member Function Documentation

execute()

static core\check\external\get_result_admintree::execute ( string $admintreeid, string $settingname, bool $includedetails, admin_root $admintree = null )

static

Gets the result of the check and returns it.

Parameters

string	$admintreeid	ID of admin_setting to find check object from
string	$settingname	Name of admin_setting to find check object from
bool	$includedetails	If the details should be included in the response.
admin_root | null	$admintree	Root of admin tree to use (for unit testing)

Return values

array

returned data

execute_parameters()

static core\check\external\get_result_admintree::execute_parameters ( )

static

Defines parameters.

Return values

external_function_parameters

execute_returns()

static core\check\external\get_result_admintree::execute_returns ( )

static

Defines return structure.

Return values

external_single_structure

---

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

• lib/classes/check/external/get_result_admintree.php