CRM_Utils_Check_Component_Cms
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.
- checkCleanurls() : array<string|int, CRM_Utils_Check_Message>
- For sites running in WordPress, make sure clean URLs are properly set in settings file.
- checkPublicAssets() : array<string|int, CRM_Utils_Check_Message>
- For sites running from Composer, ensure public assets have been correctly installed.
- checkUfMatchUnique() : array<string|int, CRM_Utils_Check_Message>
- Check if we created unique index on civicrm_uf_match (uf_id,domain_id)
- checkWpBasePage() : array<string|int, CRM_Utils_Check_Message>
- For sites running in WordPress, make sure the configured base page exists.
- 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
- pageExists() : int
- See if a page exists and is published.
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>checkCleanurls()
For sites running in WordPress, make sure clean URLs are properly set in settings file.
public
static checkCleanurls() : array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, CRM_Utils_Check_Message>checkPublicAssets()
For sites running from Composer, ensure public assets have been correctly installed.
public
static checkPublicAssets() : array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, CRM_Utils_Check_Message>checkUfMatchUnique()
Check if we created unique index on civicrm_uf_match (uf_id,domain_id)
public
static checkUfMatchUnique() : array<string|int, CRM_Utils_Check_Message>
Return values
array<string|int, CRM_Utils_Check_Message>checkWpBasePage()
For sites running in WordPress, make sure the configured base page exists.
public
static checkWpBasePage() : 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>
Return values
boolpageExists()
See if a page exists and is published.
private
static pageExists(string $slug) : int
Parameters
- $slug : string
-
The page path.
Return values
int —-1 if it's missing 0 if it's present but not published 1 if it's present and published