CRM_Utils_Check_Component_Env

class CRM_Utils_Check_Component_Env extends CRM_Utils_Check_Component

Properties

array $checksConfig from CRM_Utils_Check_Component

Methods

array
getChecksConfig()

Get the configured status checks.

from CRM_Utils_Check_Component
setChecksConfig(array $checksConfig)

No description

from CRM_Utils_Check_Component
bool
isEnabled()

Should these checks be run?

from CRM_Utils_Check_Component
array
checkAll()

Run all checks in this class.

from CRM_Utils_Check_Component
bool
isDisabled(string $method)

Is the specified check disabled.

from CRM_Utils_Check_Component
bool
fileExists(string $url, float|bool $timeoutOverride = FALSE)

Check if file exists on given URL.

from CRM_Utils_Check_Component
array
checkPhpVersion()

No description

array
checkPhpMysqli()

No description

array
checkMysqlTime()

Check that the MySQL time settings match the PHP time settings.

array
checkDebug()

No description

array
checkOutboundMail()

No description

array
checkDomainNameEmail()

Check that domain email and org name are set

array
checkDefaultMailbox()

Checks if a default bounce handling mailbox is set up

array
checkLastCron()

Checks if cron has run in a reasonable amount of time

array
checkUrlVariables()

Recommend that sites use path-variables for their directories and URLs.

array
checkDirVariables()

Recommend that sites use path-variables for their directories and URLs.

array
checkDirsWritable()

Check that important directories are writable.

array
checkVersion()

Checks if new versions are available

array
checkExtensions()

Checks if extensions are set up properly

array
checkExtensionUpgrades()

Checks if there are pending extension upgrades.

array
checkDbVersion()

Checks if CiviCRM database version is up-to-date

array
checkDbEngine()

ensure that all CiviCRM tables are InnoDB

array
checkReplyIdForMailing()

ensure reply id is set to any default value

array
checkMbstring()

Check for required mbstring extension

array
checkEnvironment()

Check if environment is Production.

array
checkResourceUrl()

Check that the resource URL points to the correct location.

array
checkMysqlUtf8mb4()

Check for utf8mb4 support by MySQL.

Details

in CRM_Utils_Check_Component at line 50
array getChecksConfig()

Get the configured status checks.

Return Value

array

Exceptions

API_Exception
UnauthorizedException

in CRM_Utils_Check_Component at line 63
setChecksConfig(array $checksConfig)

Parameters

array $checksConfig

in CRM_Utils_Check_Component at line 72
bool isEnabled()

Should these checks be run?

Return Value

bool

in CRM_Utils_Check_Component at line 85
array checkAll()

Run all checks in this class.

Return Value

array [CRM_Utils_Check_Message]

Exceptions

API_Exception
UnauthorizedException

in CRM_Utils_Check_Component at line 106
bool isDisabled(string $method)

Is the specified check disabled.

Parameters

string $method

Return Value

bool

Exceptions

API_Exception
UnauthorizedException

in CRM_Utils_Check_Component at line 132
bool fileExists(string $url, float|bool $timeoutOverride = FALSE)

Check if file exists on given URL.

Parameters

string $url
float|bool $timeoutOverride

Return Value

bool

Exceptions

GuzzleException

at line 38
array checkPhpVersion()

Return Value

array

at line 103
array checkPhpMysqli()

Return Value

array

at line 128
array checkMysqlTime()

Check that the MySQL time settings match the PHP time settings.

Return Value

array an empty array, or a list of warnings

at line 153
array checkDebug()

Return Value

array

at line 179
array checkOutboundMail()

Return Value

array

at line 205
array checkDomainNameEmail()

Check that domain email and org name are set

Return Value

array

at line 250
array checkDefaultMailbox()

Checks if a default bounce handling mailbox is set up

Return Value

array

at line 280
array checkLastCron()

Checks if cron has run in a reasonable amount of time

Return Value

array

at line 327
array checkUrlVariables()

Recommend that sites use path-variables for their directories and URLs.

Return Value

array

at line 364
array checkDirVariables()

Recommend that sites use path-variables for their directories and URLs.

Return Value

array

at line 405
array checkDirsWritable()

Check that important directories are writable.

Return Value

array Any CRM_Utils_Check_Message instances that need to be generated.

at line 453
array checkVersion()

Checks if new versions are available

Return Value

array

at line 503
array checkExtensions()

Checks if extensions are set up properly

Return Value

array

at line 699
array checkExtensionUpgrades()

Checks if there are pending extension upgrades.

Return Value

array

at line 723
array checkDbVersion()

Checks if CiviCRM database version is up-to-date

Return Value

array

at line 794
array checkDbEngine()

ensure that all CiviCRM tables are InnoDB

Return Value

array

at line 813
array checkReplyIdForMailing()

ensure reply id is set to any default value

Return Value

array

at line 832
array checkMbstring()

Check for required mbstring extension

Return Value

array

at line 851
array checkEnvironment()

Check if environment is Production.

Return Value

array

at line 871
array checkResourceUrl()

Check that the resource URL points to the correct location.

Return Value

array

at line 902
array checkMysqlUtf8mb4()

Check for utf8mb4 support by MySQL.

Return Value

array an empty array, or a list of warnings