From 527745f0819caf7c5e2bbf6cdb6f4574c511dd06 Mon Sep 17 00:00:00 2001 From: eileen Date: Tue, 31 Mar 2020 16:48:38 +1300 Subject: [PATCH] [REF] Remove fatal, fix some code comments --- CRM/Core/BAO/Domain.php | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index e01a624d97c0..4f6cc26161db 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -70,6 +70,8 @@ public static function getDomain($reset = NULL) { * @param bool $skipUsingCache * * @return null|string + * + * @throws \CRM_Core_Exception */ public static function version($skipUsingCache = FALSE) { return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain', @@ -85,6 +87,8 @@ public static function version($skipUsingCache = FALSE) { * * @return array * Location::getValues + * + * @throws \CRM_Core_Exception */ public function &getLocationValues() { if ($this->_location == NULL) { @@ -107,8 +111,7 @@ public function &getLocationValues() { * @param array $params * @param int $id * - * @return array - * domain + * @return CRM_Core_DAO_Domain */ public static function edit(&$params, &$id) { CRM_Utils_Hook::pre('edit', 'Domain', CRM_Utils_Array::value('id', $params), $params); @@ -125,8 +128,7 @@ public static function edit(&$params, &$id) { * * @param array $params * - * @return array - * domain + * @return CRM_Core_DAO_Domain */ public static function create($params) { $hook = empty($params['id']) ? 'create' : 'edit'; @@ -146,7 +148,7 @@ public static function multipleDomains() { $numberDomains = $session->get('numberDomains'); if (!$numberDomains) { - $query = "SELECT count(*) from civicrm_domain"; + $query = 'SELECT count(*) from civicrm_domain'; $numberDomains = CRM_Core_DAO::singleValueQuery($query); $session->set('numberDomains', $numberDomains); } @@ -156,9 +158,11 @@ public static function multipleDomains() { /** * @param bool $skipFatal * @param bool $returnString + * * @return array * name & email for domain - * @throws Exception + * + * @throws \CRM_Core_Exception */ public static function getNameAndEmail($skipFatal = FALSE, $returnString = FALSE) { $fromEmailAddress = CRM_Core_OptionGroup::values('from_email_address', NULL, NULL, NULL, ' AND is_default = 1'); @@ -185,13 +189,15 @@ public static function getNameAndEmail($skipFatal = FALSE, $returnString = FALSE ); $status = ts("There is no valid default from email address configured for the domain. You can configure here Configure From Email Address.", [1 => $url]); - CRM_Core_Error::fatal($status); + throw new CRM_Core_Exception($status); } /** * @param int $contactID * * @return bool|null|object|string + * + * @throws \CRM_Core_Exception */ public static function addContactToDomainGroup($contactID) { $groupID = self::getGroupId(); @@ -207,6 +213,8 @@ public static function addContactToDomainGroup($contactID) { /** * @return bool|null|object|string + * + * @throws \CRM_Core_Exception */ public static function getGroupId() { static $groupID = NULL; @@ -237,6 +245,8 @@ public static function getGroupId() { * @param int $groupId * * @return bool + * + * @throws \CRM_Core_Exception */ public static function isDomainGroup($groupId) { $domainGroupID = self::getGroupId(); @@ -245,6 +255,8 @@ public static function isDomainGroup($groupId) { /** * @return array + * + * @throws \CRM_Core_Exception */ public static function getChildGroupIds() { $domainGroupID = self::getGroupId(); @@ -261,6 +273,8 @@ public static function getChildGroupIds() { * Retrieve a list of contact-ids that belongs to current domain/site. * * @return array + * + * @throws \CRM_Core_Exception */ public static function getContactList() { $siteGroups = CRM_Core_BAO_Domain::getChildGroupIds(); @@ -285,6 +299,8 @@ public static function getContactList() { * CRM-20308 & CRM-19657 * Return domain information / user information for the usage in receipts * Try default from address then fall back to using logged in user details + * + * @throws \CiviCRM_API3_Exception */ public static function getDefaultReceiptFrom() { $domain = civicrm_api3('domain', 'getsingle', ['id' => CRM_Core_Config::domainID()]);