Documentation

CRM_Utils_Check_Component_Source 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.
checkOrphans()  : array<string|int, CRM_Utils_Check_Message>
fileExists()  : bool
Check if file exists on given URL.
findOrphanedFiles()  : array<string|int, mixed>
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.
getRemovedFiles()  : mixed
isDisabled()  : bool
Is the specified check disabled.
isEnabled()  : bool
Should these checks be run?
findCorrectCaseForFile()  : string|null
Linux is case sensitive, so this will be a no-op.
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
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

findOrphanedFiles()

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

Each item is an array with keys:

  • name: string, an abstract name
  • path: string, a full file path

getAllChecks()

Get the names of all check functions in this class

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

getRemovedFiles()

public getRemovedFiles() : mixed

isEnabled()

Should these checks be run?

public isEnabled() : bool
Return values
bool

findCorrectCaseForFile()

Linux is case sensitive, so this will be a no-op.

private findCorrectCaseForFile(string $path) : string|null

Windows is case insensitive, Mac is usually insensitive but sometimes sensitive. Note that realpath() will return the real casing for a file on windows, but not on mac, so we need a different method. glob returns the real casing, but means we need to loop.

Parameters
$path : string
Return values
string|null

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