interface EnvironmentCheck (View source)

Interface for environment checks

An environment check is a test that can be performed on a live environment. They differ from unit tests in that they are designed to check the state of the environment/server, rather than the code.

Environment checks should never alter production data.

Some things you might make environment checks for:

  • Can I access the database?
  • Are the right PHP modules installed?
  • Are the file permissions correct?

Constants

ERROR

WARNING

OK

Methods

public
array
check()

No description

Details

array check()

No description

Return Value

array

Result with 'status' and 'message' keys.

Status is EnvironmentCheck::ERROR, EnvironmentCheck::WARNING, or EnvironmentCheck::OK.