Documentation

CRM_Utils_Check_Component_Timestamps extends CRM_Utils_Check_Component
in package

Tags
copyright

CiviCRM LLC https://civicrm.org/licensing

Table of Contents

Constants

DOCTOR_WHEN  = 'https://github.com/civicrm/org.civicrm.doctorwhen'

Methods

checkAll()  : array<string|int, CRM_Utils_Check_Message>
Run all checks in this class.
checkSchema()  : array<string|int, CRM_Utils_Check_Message>
Check that various columns are TIMESTAMP and not DATETIME. (CRM-9683, etal)
checkTimezoneAPIs()  : array<string|int, CRM_Utils_Check_Message>
Check that MySQL actually supports timezone operations.
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.
getConvertedTimestamps()  : mixed
isDisabled()  : bool
Is the specified check disabled.
isEnabled()  : bool
Should these checks be run?
isFieldType()  : bool
isRequested()  : bool
Is this check one of those requested

Constants

DOCTOR_WHEN

public mixed DOCTOR_WHEN = 'https://github.com/civicrm/org.civicrm.doctorwhen'

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>

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>

getConvertedTimestamps()

public static getConvertedTimestamps() : mixed

isEnabled()

Should these checks be run?

public isEnabled() : bool
Return values
bool

isFieldType()

public static isFieldType(string $table, string $column, string $expectType) : bool
Parameters
$table : string

Ex: 'civicrm_log'.

$column : string

Ex: 'modified_date'.

$expectType : string

Ex: 'datetime' or 'timestamp'.

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

        
On this page

Search results