Documentation

CRM_Utils_Check_Component_Case 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'

Properties

$caseTypeNames  : array<string|int, string>
$xmlRepo  : CRM_Case_XMLRepository

Methods

__construct()  : mixed
Class constructor.
checkAll()  : array<string|int, CRM_Utils_Check_Message>
Run all checks in this class.
checkCaseTypeNameConsistency()  : array<string|int, CRM_Utils_Check_Message>
Check that the case-type names don't rely on double-munging.
checkCaseTypeNameValidity()  : mixed
At some point the valid names changed so that you can't have e.g. spaces.
checkExternalXmlFileRoleNames()  : array<string|int, CRM_Utils_Check_Message>
Check any xml definitions stored as external files to see if they have label as the role and where the label is different from the name.
checkNullTimestamps()  : array<string|int, CRM_Utils_Check_Message>
Check that the timestamp columns are populated. (CRM-20958)
checkRelationshipTypeProblems()  : array<string|int, CRM_Utils_Check_Message>
Check that the relationship types aren't going to cause problems.
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

Constants

DOCTOR_WHEN

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

Properties

$caseTypeNames

protected array<string|int, string> $caseTypeNames

Methods

__construct()

Class constructor.

public __construct() : mixed

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>

checkCaseTypeNameConsistency()

Check that the case-type names don't rely on double-munging.

public checkCaseTypeNameConsistency() : array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, CRM_Utils_Check_Message> —

An empty array, or a list of warnings

checkCaseTypeNameValidity()

At some point the valid names changed so that you can't have e.g. spaces.

public checkCaseTypeNameValidity() : mixed

For systems upgraded that use external xml files it's then not clear why the other messages about outdated filenames are coming up because when you then fix it as suggested it then gives a red error just saying it can't find it.

checkExternalXmlFileRoleNames()

Check any xml definitions stored as external files to see if they have label as the role and where the label is different from the name.

public checkExternalXmlFileRoleNames() : array<string|int, CRM_Utils_Check_Message>

We don't have to think about edge cases because there are already status checks above for those.

Return values
array<string|int, CRM_Utils_Check_Message> —

An empty array, or a list of warnings

checkNullTimestamps()

Check that the timestamp columns are populated. (CRM-20958)

public checkNullTimestamps() : array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, CRM_Utils_Check_Message> —

An empty array, or a list of warnings

checkRelationshipTypeProblems()

Check that the relationship types aren't going to cause problems.

public checkRelationshipTypeProblems() : array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, CRM_Utils_Check_Message> —

An empty array, or a list of warnings

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
Tags
inheritDoc
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