CRM_Utils_Check_Component_Schema
extends CRM_Utils_Check_Component
in package
Tags
Table of Contents
Methods
- checkAll() : array<string|int, CRM_Utils_Check_Message>
- Run all checks in this class.
- checkIndices() : array<string|int, CRM_Utils_Check_Message>
- Check defined indices exist.
- checkMissingLogTables() : array<string|int, CRM_Utils_Check_Message>
- checkMoneyValueFormatConfig() : array<string|int, CRM_Utils_Check_Message>
- checkOldAcitvityCascade() : array<string|int, CRM_Utils_Check_Message>
- The column 'civicrm_activity.original_id' should not have 'ON DELETE CASCADE'.
- checkPhoneFunctionExists() : array<string|int, mixed>|array<string|int, CRM_Utils_Check_Message>
- Check the function to populate phone_numeric exists.
- checkRelationshipCacheData() : array<string|int, mixed>|array<string|int, CRM_Utils_Check_Message>
- Verify `civicrm_relationship_cache` table contains the right amount of data.
- checkRelationshipCacheTriggers() : array<string|int, mixed>|array<string|int, CRM_Utils_Check_Message>
- Check the SQL trigger to populate `civicrm_relationship_cache` exists.
- checkSmartGroupCustomFieldCriteria() : array<string|int, CRM_Utils_Check_Message>
- Check that no smart groups exist that contain deleted custom fields.
- 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
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
Return values
array<string|int, CRM_Utils_Check_Message>checkIndices()
Check defined indices exist.
public
checkIndices() : array<string|int, CRM_Utils_Check_Message>
Tags
Return values
array<string|int, CRM_Utils_Check_Message>checkMissingLogTables()
public
checkMissingLogTables() : array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, CRM_Utils_Check_Message>checkMoneyValueFormatConfig()
public
checkMoneyValueFormatConfig() : array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, CRM_Utils_Check_Message>checkOldAcitvityCascade()
The column 'civicrm_activity.original_id' should not have 'ON DELETE CASCADE'.
public
checkOldAcitvityCascade() : array<string|int, CRM_Utils_Check_Message>
It is OK to have 'ON DELETE SET NULL' or to have no constraint.
Return values
array<string|int, CRM_Utils_Check_Message>checkPhoneFunctionExists()
Check the function to populate phone_numeric exists.
public
checkPhoneFunctionExists() : array<string|int, mixed>|array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, mixed>|array<string|int, CRM_Utils_Check_Message>checkRelationshipCacheData()
Verify `civicrm_relationship_cache` table contains the right amount of data.
public
checkRelationshipCacheData() : array<string|int, mixed>|array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, mixed>|array<string|int, CRM_Utils_Check_Message>checkRelationshipCacheTriggers()
Check the SQL trigger to populate `civicrm_relationship_cache` exists.
public
checkRelationshipCacheTriggers() : array<string|int, mixed>|array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, mixed>|array<string|int, CRM_Utils_Check_Message>checkSmartGroupCustomFieldCriteria()
Check that no smart groups exist that contain deleted custom fields.
public
checkSmartGroupCustomFieldCriteria() : array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, CRM_Utils_Check_Message>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
Return values
boolgetAllChecks()
Get the names of all check functions in this class
public
getAllChecks() : array<string|int, string>
Return values
array<string|int, string>getChecksConfig()
Get the configured status checks.
public
getChecksConfig() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>isDisabled()
Is the specified check disabled.
public
isDisabled(string $method) : bool
Parameters
- $method : string
Tags
Return values
boolisEnabled()
Should these checks be run?
public
isEnabled() : bool
Return values
boolisRequested()
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>