core\check\check Class Reference

Base class for checks. More...

Inheritance diagram for core\check\check:

Public Member Functions
	get_action_link ()
	A link to a place to action this.
	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 the result.
	set_component (string $component)
	Get the frankenstyle component name.

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

Detailed Description

Base class for checks.

Copyright

2020 Brendan Heywood brend.nosp@m.an@c.nosp@m.ataly.nosp@m.st-a.nosp@m.u.net

License

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

Member Function Documentation

get_action_link()

core\check\check::get_action_link

(

)

A link to a place to action this.

Return values

action_link|null

Reimplemented in auth_none\check\noauth, 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\environment, core\check\environment\publicpaths, 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, core\check\security\webcron, search_solr\check\connection, tool_task\check\adhocqueue, tool_task\check\cronrunning, tool_task\check\longrunningtasks, and tool_task\check\maxfaildelay.

get_component()

core\check\check::get_component

(

)

Get the frankenstyle component name.

Return values

string

get_id()

core\check\check::get_id

(

)

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

(

)

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, core\check\security\webcron, and search_solr\check\connection.

get_ref()

core\check\check::get_ref

(

)

Get the check reference.

Return values

string

must be globally unique

get_result()

core\check\check::get_result ( )

abstract

Return the result.

Return values

result

object

Reimplemented in auth_none\check\noauth, 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, core\check\security\webcron, search_solr\check\connection, tool_task\check\adhocqueue, tool_task\check\cronrunning, tool_task\check\longrunningtasks, and tool_task\check\maxfaildelay.

set_component()

core\check\check::set_component

(

string

$component

)

Get the frankenstyle component name.

Parameters

string

$component

name

Member Data Documentation

$component

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

protected

$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:

• lib/classes/check/check.php