core\check\environment\environment Class Reference

Environment check. More...

Inheritance diagram for core\check\environment\environment:

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 result.
	set_component (string $component)
	Get the frankenstyle component name.

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

Detailed Description

Environment check.

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\environment\environment::get_action_link

(

)

A link to a place to action this.

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

string

must be unique within a component

get_name()

core\check\environment\environment::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

string

must be globally unique

get_result()

core\check\environment\environment::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:

• lib/classes/check/environment/environment.php