tool_task\check\longrunningtasks Class Reference

Inheritance diagram for tool_task\check\longrunningtasks:

Public Member Functions
	get_action_link ()
	Links to the running task list.
	get_component ()
	Get the frankenstyle component name.
	get_id ()
	Get the check's id.
	get_name ()
	Get the short check name.
	get_ref ()
	Get the check reference.
	get_result ()
	Return result.
	set_component (string $component)
	Get the frankenstyle component name.

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

Member Function Documentation

get_action_link()

tool_task\check\longrunningtasks::get_action_link

(

)

Links to the running task list.

Return values

action_link|null

Exceptions

coding_exception

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

string

must be unique within a component

get_name()

core\check\check::get_name ( )

inherited

Get the short check name.

Return values

string

Reimplemented in core\check\access\defaultuserrole, core\check\access\frontpagerole, core\check\access\guestrole, core\check\access\riskadmin, core\check\access\riskbackup, core\check\access\riskxss, core\check\environment\antivirus, core\check\environment\configrw, core\check\environment\displayerrors, core\check\environment\environment, core\check\environment\preventexecpath, core\check\environment\publicpaths, core\check\environment\unsecuredataroot, core\check\environment\upgradecheck, core\check\http\cookiesecure, core\check\performance\backups, core\check\performance\cachejs, core\check\performance\dbschema, core\check\performance\debugging, core\check\performance\designermode, core\check\performance\stats, core\check\security\crawlers, core\check\security\emailchangeconfirmation, core\check\security\embed, core\check\security\openprofiles, core\check\security\passwordpolicy, and core\check\security\webcron.

get_ref()

core\check\check::get_ref ( )

inherited

Get the check reference.

Return values

string

must be globally unique

get_result()

tool_task\check\longrunningtasks::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

$component

name

Member Data Documentation

$component

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

protectedinherited

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

This is autopopulated by the check manager.

---

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

• admin/tool/task/classes/check/longrunningtasks.php