Documentation

CRM_Utils_Check_Component_Env extends CRM_Utils_Check_Component
in package

Tags
copyright

CiviCRM LLC https://civicrm.org/licensing

Table of Contents

Methods

checkAll()  : array<string|int, CRM_Utils_Check_Message>
Run all checks in this class.
checkAngularModuleSettings()  : array<string|int, mixed>
checkComponents()  : array<string|int, mixed>
Ensure that *some* CiviCRM components (component-extensions) are enabled.
checkDbEngine()  : array<string|int, CRM_Utils_Check_Message>
Ensure that all CiviCRM tables are InnoDB
checkDbVersion()  : array<string|int, CRM_Utils_Check_Message>
Checks if CiviCRM database version is up-to-date
checkDebug()  : array<string|int, CRM_Utils_Check_Message>
checkDefaultMailbox()  : array<string|int, CRM_Utils_Check_Message>
Checks if a default bounce handling mailbox is set up
checkDirsWritable()  : array<string|int, CRM_Utils_Check_Message>
Check that important directories are writable.
checkDirVariables()  : array<string|int, CRM_Utils_Check_Message>
Recommend that sites use path-variables for their directories and URLs.
checkDomainNameEmail()  : array<string|int, CRM_Utils_Check_Message>
Check that domain email and org name are set
checkEnvironment()  : array<string|int, CRM_Utils_Check_Message>
Check if environment is Production.
checkExcludeDirectories()  : array<string|int, mixed>
Let people know if they could improve performance by defining the exclude directory.
checkExtensions()  : array<string|int, CRM_Utils_Check_Message>
Checks if extensions are set up properly
checkExtensionUpgrades()  : array<string|int, CRM_Utils_Check_Message>
Checks if there are pending extension upgrades.
checkForMultipleL10NDirs()  : array<string|int, mixed>
checkLastCron()  : array<string|int, CRM_Utils_Check_Message>
Checks if cron has run in the past hour (3600 seconds)
checkLoggingHasCiviReport()  : array<string|int, CRM_Utils_Check_Message>
Checks if logging is enabled but Civi-report is not.
checkMbstring()  : array<string|int, CRM_Utils_Check_Message>
Check for required mbstring extension
checkMysqlTime()  : array<string|int, CRM_Utils_Check_Message>
Check that the MySQL time settings match the PHP time settings.
checkMysqlUtf8mb4()  : array<string|int, CRM_Utils_Check_Message>
Check for utf8mb4 support by MySQL.
checkMysqlVersion()  : mixed
checkOutboundMail()  : array<string|int, CRM_Utils_Check_Message>
checkPHPIntlExists()  : array<string|int, mixed>
checkPhpMysqli()  : array<string|int, CRM_Utils_Check_Message>
checkPhpVersion()  : array<string|int, CRM_Utils_Check_Message>
checkReplyIdForMailing()  : array<string|int, CRM_Utils_Check_Message>
Ensure reply id is set to any default value
checkScheduledJobLogErrors()  : array<string|int, CRM_Utils_Check_Message>
checkTemplateCompileCheck()  : array<string|int, mixed>
Let people know if they could improve performance by defining the template compile check.
checkUrlVariables()  : array<string|int, CRM_Utils_Check_Message>
Recommend that sites use path-variables for their directories and URLs.
checkVersion()  : array<string|int, CRM_Utils_Check_Message>
Checks if new versions are available
fileExists()  : bool
Check if file exists on given URL.
getAllChecks()  : array<string|int, string>
Get the names of all check functions in this class
getChecksConfig()  : array<string|int, mixed>
Get the configured status checks.
isDisabled()  : bool
Is the specified check disabled.
isEnabled()  : bool
Should these checks be run?
isRequested()  : bool
Is this check one of those requested
normalizePath()  : string
Avoid issues with trailing slashes and mixed separators on windows.

Methods

checkAll()

Run all checks in this class.

public checkAll([array<string|int, mixed> $requestedChecks = [] ][, bool $includeDisabled = FALSE ]) : array<string|int, CRM_Utils_Check_Message>
Parameters
$requestedChecks : array<string|int, mixed> = []

Optionally specify the names of specific checks requested, or leave empty to run all

$includeDisabled : bool = FALSE

Run checks that have been explicitly disabled (default false)

Tags
throws
CRM_Core_Exception
throws
UnauthorizedException
Return values
array<string|int, CRM_Utils_Check_Message>

checkAngularModuleSettings()

public checkAngularModuleSettings() : array<string|int, mixed>
Return values
array<string|int, mixed>

checkComponents()

Ensure that *some* CiviCRM components (component-extensions) are enabled.

public checkComponents() : array<string|int, mixed>

It is believed that some sites lost their list of active-components due to a flawed upgrade-step circa 5.62/5.63. The upgrade-step has been fixed (civicrm-core#27075), but some sites may still have bad configurations.

This problem should generally be obvious after running web-based upgrader, but it's not obvious in scripted+CLI upgrades.

Tags
throws
CRM_Core_Exception
throws
UnauthorizedException
Return values
array<string|int, mixed>

checkDefaultMailbox()

Checks if a default bounce handling mailbox is set up

public checkDefaultMailbox([bool $force = FALSE ]) : array<string|int, CRM_Utils_Check_Message>
Parameters
$force : bool = FALSE
Return values
array<string|int, CRM_Utils_Check_Message>

checkDomainNameEmail()

Check that domain email and org name are set

public checkDomainNameEmail([bool $force = FALSE ]) : array<string|int, CRM_Utils_Check_Message>
Parameters
$force : bool = FALSE
Return values
array<string|int, CRM_Utils_Check_Message>

checkExcludeDirectories()

Let people know if they could improve performance by defining the exclude directory.

public checkExcludeDirectories() : array<string|int, mixed>
Return values
array<string|int, mixed>

checkForMultipleL10NDirs()

public checkForMultipleL10NDirs() : array<string|int, mixed>
Return values
array<string|int, mixed>

checkMysqlVersion()

public checkMysqlVersion() : mixed

checkPHPIntlExists()

public checkPHPIntlExists() : array<string|int, mixed>
Return values
array<string|int, mixed>

checkReplyIdForMailing()

Ensure reply id is set to any default value

public checkReplyIdForMailing([bool $force = FALSE ]) : array<string|int, CRM_Utils_Check_Message>
Parameters
$force : bool = FALSE
Return values
array<string|int, CRM_Utils_Check_Message>

checkTemplateCompileCheck()

Let people know if they could improve performance by defining the template compile check.

public checkTemplateCompileCheck() : array<string|int, mixed>
Return values
array<string|int, mixed>

fileExists()

Check if file exists on given URL.

public fileExists(string $url[, float|bool $timeoutOverride = FALSE ]) : bool
Parameters
$url : string
$timeoutOverride : float|bool = FALSE
Tags
throws
GuzzleException
Return values
bool

getAllChecks()

Get the names of all check functions in this class

public getAllChecks() : array<string|int, string>
Return values
array<string|int, string>

isEnabled()

Should these checks be run?

public isEnabled() : bool
Return values
bool

isRequested()

Is this check one of those requested

private isRequested(string $method, array<string|int, mixed> $requestedChecks) : bool
Parameters
$method : string
$requestedChecks : array<string|int, mixed>
Return values
bool

normalizePath()

Avoid issues with trailing slashes and mixed separators on windows.

private static normalizePath(string $path) : string
Parameters
$path : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results