*/
class CRM_Utils_Check_Component_AddressParsing extends CRM_Utils_Check_Component {
+ /**
+ * @return CRM_Utils_Check_Message[]
+ */
public static function checkLocaleSupportsAddressParsing() {
$addressOptions = CRM_Core_BAO_Setting::valueOptions(
/**
* Check that the case-type names don't rely on double-munging.
*
- * @return array<CRM_Utils_Check_Message>
+ * @return CRM_Utils_Check_Message[]
* An empty array, or a list of warnings
*/
public function checkCaseTypeNameConsistency() {
/**
* Check that the timestamp columns are populated. (CRM-20958)
*
- * @return array<CRM_Utils_Check_Message>
+ * @return CRM_Utils_Check_Message[]
* An empty array, or a list of warnings
*/
public function checkNullTimestamps() {
/**
* Check that the relationship types aren't going to cause problems.
*
- * @return array<CRM_Utils_Check_Message>
+ * @return CRM_Utils_Check_Message[]
* An empty array, or a list of warnings
*/
public function checkRelationshipTypeProblems() {
* We don't have to think about edge cases because there are already
* status checks above for those.
*
- * @return array<CRM_Utils_Check_Message>
+ * @return CRM_Utils_Check_Message[]
* An empty array, or a list of warnings
*/
public function checkExternalXmlFileRoleNames() {
/**
* For sites running in WordPress, make sure the configured base page exists.
*
- * @return array
- * Instances of CRM_Utils_Check_Message
+ * @return CRM_Utils_Check_Message[]
*/
public static function checkWpBasePage() {
$config = CRM_Core_Config::singleton();
class CRM_Utils_Check_Component_Env extends CRM_Utils_Check_Component {
/**
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkPhpVersion() {
$messages = [];
}
/**
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkPhpMysqli() {
$messages = [];
/**
* Check that the MySQL time settings match the PHP time settings.
*
- * @return array<CRM_Utils_Check_Message> an empty array, or a list of warnings
+ * @return CRM_Utils_Check_Message[]
*/
public function checkMysqlTime() {
$messages = [];
}
/**
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkDebug() {
$config = CRM_Core_Config::singleton();
}
/**
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkOutboundMail() {
$messages = [];
/**
* Check that domain email and org name are set
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkDomainNameEmail() {
$messages = [];
/**
* Checks if a default bounce handling mailbox is set up
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkDefaultMailbox() {
$messages = [];
/**
* Checks if cron has run in the past hour (3600 seconds)
- * @return array
+ * @return CRM_Utils_Check_Message[]
* @throws CRM_Core_Exception
*/
public function checkLastCron() {
/**
* Recommend that sites use path-variables for their directories and URLs.
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkUrlVariables() {
$messages = [];
/**
* Recommend that sites use path-variables for their directories and URLs.
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkDirVariables() {
$messages = [];
/**
* Check that important directories are writable.
*
- * @return array
- * Any CRM_Utils_Check_Message instances that need to be generated.
+ * @return CRM_Utils_Check_Message[]
*/
public function checkDirsWritable() {
$notWritable = [];
/**
* Checks if new versions are available
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkVersion() {
$messages = [];
/**
* Checks if extensions are set up properly
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkExtensions() {
$messages = [];
/**
* Checks if there are pending extension upgrades.
*
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkExtensionUpgrades() {
if (CRM_Extension_Upgrades::hasPending()) {
/**
* Checks if CiviCRM database version is up-to-date
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkDbVersion() {
$messages = [];
}
/**
- * ensure that all CiviCRM tables are InnoDB
- * @return array
+ * Ensure that all CiviCRM tables are InnoDB
+ * @return CRM_Utils_Check_Message[]
*/
public function checkDbEngine() {
$messages = [];
}
/**
- * ensure reply id is set to any default value
- * @return array
+ * Ensure reply id is set to any default value
+ * @return CRM_Utils_Check_Message[]
*/
public function checkReplyIdForMailing() {
$messages = [];
/**
* Check for required mbstring extension
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkMbstring() {
$messages = [];
/**
* Check if environment is Production.
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkEnvironment() {
$messages = [];
/**
* Check for utf8mb4 support by MySQL.
*
- * @return array<CRM_Utils_Check_Message> an empty array, or a list of warnings
+ * @return CRM_Utils_Check_Message[]
*/
public function checkMysqlUtf8mb4() {
$messages = [];
*/
class CRM_Utils_Check_Component_FinancialTypeAcls extends CRM_Utils_Check_Component {
+ /**
+ * @return CRM_Utils_Check_Message[]
+ * @throws CiviCRM_API3_Exception
+ */
public static function checkFinancialAclReport() {
$messages = [];
$ftAclSetting = Civi::settings()->get('acl_financial_type');
class CRM_Utils_Check_Component_OptionGroups extends CRM_Utils_Check_Component {
/**
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkOptionGroupValues() {
$messages = [];
/**
* Display warning about invalid priceFields
- *
+ * @return CRM_Utils_Check_Message[]
*/
public function checkPriceFields() {
$sql = "SELECT DISTINCT ps.title as ps_title, ps.id as ps_id, psf.label as psf_label
/**
* Check defined indices exist.
*
- * @return array
+ * @return CRM_Utils_Check_Message[]
* @throws \CiviCRM_API3_Exception
*/
public function checkIndices() {
}
/**
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkMissingLogTables() {
$messages = [];
/**
* Check that no smart groups exist that contain deleted custom fields.
*
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkSmartGroupCustomFieldCriteria() {
if (CRM_Core_BAO_Domain::isDBUpdateRequired()) {
return $messages;
}
+ /**
+ * @return CRM_Utils_Check_Message[]
+ */
public function checkMoneyValueFormatConfig() {
$messages = [];
if (CRM_Core_Config::singleton()->moneyvalueformat !== '%!i') {
* CMS have a different pattern to their default file path and URL.
*
* @todo Use Civi::paths instead?
+ * @return string
*/
public function getFilePathMarker() {
$config = CRM_Core_Config::singleton();
* is browseable or visible to search engines; it means it can be
* requested directly.
*
- * @return array
- * Array of messages
+ * @return CRM_Utils_Check_Message[]
* @see CRM-14091
*/
public function checkLogFileIsNotAccessible() {
* Being retrievable doesn't mean the files are browseable or visible
* to search engines; it only means they can be requested directly.
*
- * @return array
- * Array of messages
+ * @return CRM_Utils_Check_Message[]
* @see CRM-14091
*
* @todo Test with WordPress, Joomla.
* MAY trigger false positives (if you have files named 'a', 'e'
* we'll probably match that).
*
- * @return array
- * Array of messages
+ * @return CRM_Utils_Check_Message[]
* @see CRM-14091
*
* @todo Test with WordPress, Joomla.
* These files have generally been deleted but Civi source tree but could be
* left online if one does a faulty upgrade.
*
- * @return array of messages
+ * @return CRM_Utils_Check_Message[]
*/
public function checkFilesAreNotPresent() {
$packages_path = rtrim(\Civi::paths()->getPath('[civicrm.packages]/'), '/' . DIRECTORY_SEPARATOR);
/**
* Discourage use of remote profile forms.
+ * @return CRM_Utils_Check_Message[]
*/
public function checkRemoteProfile() {
$messages = [];
}
/**
- * Check that the sysadmin has not modified the Cxn
- * security setup.
+ * Check that the sysadmin has not modified the Cxn security setup.
+ * @return CRM_Utils_Check_Message[]
*/
public function checkCxnOverrides() {
$list = [];
}
/**
- * @return array
+ * @return CRM_Utils_Check_Message[]
* Each item is an array with keys:
* - name: string, an abstract name
* - path: string, a full file path
}
/**
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkOrphans() {
$orphans = $this->findOrphanedFiles();
/**
* Check that various columns are TIMESTAMP and not DATETIME. (CRM-9683, etal)
*
- * @return array
+ * @return CRM_Utils_Check_Message[]
*/
public function checkSchema() {
$problems = [];
projects / civicrm-core.git / commitdiff