From d7204a65f9575423e883ae74cc42efed23d264d1 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Sun, 2 Apr 2023 20:38:35 -0400 Subject: [PATCH] REF - Noisily deprecate BAO::retrieve functions --- CRM/ACL/BAO/ACL.php | 10 +--- CRM/ACL/BAO/ACLEntityRole.php | 10 +--- CRM/Campaign/BAO/Campaign.php | 10 +--- CRM/Campaign/BAO/Survey.php | 9 +--- CRM/Contact/BAO/ContactType.php | 10 +--- CRM/Contact/BAO/Group.php | 9 +--- CRM/Contact/BAO/RelationshipType.php | 9 +--- CRM/Contribute/BAO/Product.php | 17 ++----- CRM/Core/BAO/CustomField.php | 9 +--- CRM/Core/BAO/CustomGroup.php | 9 +--- CRM/Core/BAO/Domain.php | 9 +--- CRM/Core/BAO/Extension.php | 10 +--- CRM/Core/BAO/Job.php | 10 +--- CRM/Core/BAO/LocationType.php | 9 +--- CRM/Core/BAO/MailSettings.php | 10 +--- CRM/Core/BAO/Mapping.php | 10 +--- CRM/Core/BAO/MessageTemplate.php | 10 +--- CRM/Core/BAO/OptionGroup.php | 9 +--- CRM/Core/BAO/OptionValue.php | 9 +--- CRM/Core/BAO/PreferencesDate.php | 10 +--- CRM/Core/BAO/Tag.php | 10 +--- CRM/Core/BAO/UFField.php | 10 +--- CRM/Core/BAO/WordReplacement.php | 10 +--- CRM/Event/BAO/Event.php | 9 +--- CRM/Event/BAO/ParticipantStatusType.php | 9 +--- CRM/Financial/BAO/FinancialItem.php | 10 +--- CRM/Financial/BAO/FinancialType.php | 10 +--- CRM/Financial/BAO/PaymentProcessor.php | 10 +--- CRM/Financial/BAO/PaymentProcessorType.php | 9 +--- CRM/Friend/BAO/Friend.php | 9 +--- CRM/Mailing/BAO/MailingComponent.php | 10 +--- CRM/Member/BAO/MembershipStatus.php | 10 +--- CRM/Member/BAO/MembershipType.php | 9 +--- CRM/Pledge/BAO/Pledge.php | 10 +--- CRM/Pledge/BAO/PledgeBlock.php | 9 +--- CRM/Pledge/BAO/PledgePayment.php | 9 +--- CRM/Price/BAO/PriceField.php | 9 +--- CRM/Price/BAO/PriceFieldValue.php | 9 +--- CRM/Price/BAO/PriceSet.php | 9 +--- CRM/Report/BAO/ReportInstance.php | 9 +--- .../CRM/Financial/BAO/FinancialItemTest.php | 39 -------------- .../CRM/Member/BAO/MembershipStatusTest.php | 51 ------------------- tests/phpunit/CRM/Pledge/BAO/PledgeTest.php | 30 ----------- 43 files changed, 63 insertions(+), 444 deletions(-) diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index 2e78ea666f..6668ff4e33 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -156,19 +156,13 @@ SELECT acl.* } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/ACL/BAO/ACLEntityRole.php b/CRM/ACL/BAO/ACLEntityRole.php index 26ae773ad1..65be324ce7 100644 --- a/CRM/ACL/BAO/ACLEntityRole.php +++ b/CRM/ACL/BAO/ACLEntityRole.php @@ -44,19 +44,13 @@ class CRM_ACL_BAO_ACLEntityRole extends CRM_ACL_DAO_ACLEntityRole { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index ee01e49e3e..311fc935d6 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -88,19 +88,13 @@ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index 3f42995ee0..ba957f8f5b 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -21,17 +21,10 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey implements Civi\Core\HookInterface { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index 77eaa89407..0ff52f1047 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -17,19 +17,13 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType implements \Civi\Core\HookInterface { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index 27c5a65f2f..c718b3ce44 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -19,17 +19,10 @@ use Civi\Api4\Group; class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Contact/BAO/RelationshipType.php b/CRM/Contact/BAO/RelationshipType.php index e74b475c3d..96408eb097 100644 --- a/CRM/Contact/BAO/RelationshipType.php +++ b/CRM/Contact/BAO/RelationshipType.php @@ -21,17 +21,10 @@ use Civi\Core\Event\PreEvent; class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType implements \Civi\Core\HookInterface { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Contribute/BAO/Product.php b/CRM/Contribute/BAO/Product.php index f4f6f5f4dc..24ba30d8aa 100644 --- a/CRM/Contribute/BAO/Product.php +++ b/CRM/Contribute/BAO/Product.php @@ -23,24 +23,17 @@ class CRM_Contribute_BAO_Product extends CRM_Contribute_DAO_Product { public static $_defaultContributionType = NULL; /** - * Fetch object based on array of properties. - * + * @deprecated * @param array $params - * (reference ) an assoc array of name/value pairs. * @param array $defaults - * (reference ) an assoc array to hold the flattened values. - * - * @return CRM_Contribute_BAO_Product + * @return self|null */ public static function retrieve(&$params, &$defaults) { - $premium = new CRM_Contribute_DAO_Product(); - $premium->copyValues($params); - if ($premium->find(TRUE)) { + $premium = self::commonRetrieve(self::class, $params, $defaults); + if ($premium) { $premium->product_name = $premium->name; - CRM_Core_DAO::storeValues($premium, $defaults); - return $premium; } - return NULL; + return $premium; } /** diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index 5da3581da9..5725f960ea 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -246,17 +246,10 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index a4a33744a6..586b148d6f 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -218,17 +218,10 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup implements \Civi } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index c3642ccbab..b81d5add43 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -40,17 +40,10 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Core/BAO/Extension.php b/CRM/Core/BAO/Extension.php index 4bb87024ed..9d07e8cb69 100644 --- a/CRM/Core/BAO/Extension.php +++ b/CRM/Core/BAO/Extension.php @@ -21,19 +21,13 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php index 1f8fd506fb..c281bf8a71 100644 --- a/CRM/Core/BAO/Job.php +++ b/CRM/Core/BAO/Job.php @@ -35,19 +35,13 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Core/BAO/LocationType.php b/CRM/Core/BAO/LocationType.php index 6493470d3d..0de77f2a66 100644 --- a/CRM/Core/BAO/LocationType.php +++ b/CRM/Core/BAO/LocationType.php @@ -27,17 +27,10 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType implements \Ci public static $_billingLocationType = NULL; /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Core/BAO/MailSettings.php b/CRM/Core/BAO/MailSettings.php index f0752fb543..7b13eca108 100644 --- a/CRM/Core/BAO/MailSettings.php +++ b/CRM/Core/BAO/MailSettings.php @@ -103,19 +103,13 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index f184420c33..07abc10379 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -17,19 +17,13 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping implements \Civi\Core\HookInterface { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php index 9b70920b2d..fdf9528205 100644 --- a/CRM/Core/BAO/MessageTemplate.php +++ b/CRM/Core/BAO/MessageTemplate.php @@ -26,19 +26,13 @@ require_once 'Mail/mime.php'; class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate implements \Civi\Core\HookInterface { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Core/BAO/OptionGroup.php b/CRM/Core/BAO/OptionGroup.php index bd3ffe9c33..b9a1c99ae8 100644 --- a/CRM/Core/BAO/OptionGroup.php +++ b/CRM/Core/BAO/OptionGroup.php @@ -17,17 +17,10 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup implements \Civi\Core\HookInterface { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Core/BAO/OptionValue.php b/CRM/Core/BAO/OptionValue.php index 622fca1c20..a7d3c2562d 100644 --- a/CRM/Core/BAO/OptionValue.php +++ b/CRM/Core/BAO/OptionValue.php @@ -90,17 +90,10 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue implements \Civi } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Core/BAO/PreferencesDate.php b/CRM/Core/BAO/PreferencesDate.php index 9263f6b230..86ff352351 100644 --- a/CRM/Core/BAO/PreferencesDate.php +++ b/CRM/Core/BAO/PreferencesDate.php @@ -17,19 +17,13 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Core/BAO/Tag.php b/CRM/Core/BAO/Tag.php index 7991e8cb73..152a797c34 100644 --- a/CRM/Core/BAO/Tag.php +++ b/CRM/Core/BAO/Tag.php @@ -22,19 +22,13 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { protected $tree; /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php index 5ade83e12f..c34d0ec548 100644 --- a/CRM/Core/BAO/UFField.php +++ b/CRM/Core/BAO/UFField.php @@ -114,19 +114,13 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index e3429a12b0..2de2135cad 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -21,19 +21,13 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement implements \Civi\Core\HookInterface { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index 6b9154a173..4cbc3f023b 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -17,17 +17,10 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event implements \Civi\Core\HookInterface { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Event/BAO/ParticipantStatusType.php b/CRM/Event/BAO/ParticipantStatusType.php index 4c0941166f..7176dcc48b 100644 --- a/CRM/Event/BAO/ParticipantStatusType.php +++ b/CRM/Event/BAO/ParticipantStatusType.php @@ -71,17 +71,10 @@ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatu } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Financial/BAO/FinancialItem.php b/CRM/Financial/BAO/FinancialItem.php index 4e1680d59a..4350de8e73 100644 --- a/CRM/Financial/BAO/FinancialItem.php +++ b/CRM/Financial/BAO/FinancialItem.php @@ -17,19 +17,13 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Financial/BAO/FinancialType.php b/CRM/Financial/BAO/FinancialType.php index bb2cc98d7f..a8a47383fe 100644 --- a/CRM/Financial/BAO/FinancialType.php +++ b/CRM/Financial/BAO/FinancialType.php @@ -32,19 +32,13 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType im public static $_statusACLFt = []; /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index 986adf5573..95e7ce2931 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -73,19 +73,13 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Financial/BAO/PaymentProcessorType.php b/CRM/Financial/BAO/PaymentProcessorType.php index 356dc2bb59..820200736d 100644 --- a/CRM/Financial/BAO/PaymentProcessorType.php +++ b/CRM/Financial/BAO/PaymentProcessorType.php @@ -23,17 +23,10 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr public static $_defaultPaymentProcessorType = NULL; /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Friend/BAO/Friend.php b/CRM/Friend/BAO/Friend.php index 39a090dc78..6e97730cce 100644 --- a/CRM/Friend/BAO/Friend.php +++ b/CRM/Friend/BAO/Friend.php @@ -45,17 +45,10 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Mailing/BAO/MailingComponent.php b/CRM/Mailing/BAO/MailingComponent.php index 72c75cb63a..f015b5cb91 100644 --- a/CRM/Mailing/BAO/MailingComponent.php +++ b/CRM/Mailing/BAO/MailingComponent.php @@ -17,19 +17,13 @@ class CRM_Mailing_BAO_MailingComponent extends CRM_Mailing_DAO_MailingComponent { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Member/BAO/MembershipStatus.php b/CRM/Member/BAO/MembershipStatus.php index a2e8895412..48175688ff 100644 --- a/CRM/Member/BAO/MembershipStatus.php +++ b/CRM/Member/BAO/MembershipStatus.php @@ -17,19 +17,13 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus implements \Civi\Core\HookInterface { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Member/BAO/MembershipType.php b/CRM/Member/BAO/MembershipType.php index d51f768d7f..8e490af173 100644 --- a/CRM/Member/BAO/MembershipType.php +++ b/CRM/Member/BAO/MembershipType.php @@ -25,17 +25,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType implem public static $_membershipTypeInfo = []; /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Pledge/BAO/Pledge.php b/CRM/Pledge/BAO/Pledge.php index 546a9aa290..f1312cfbf9 100644 --- a/CRM/Pledge/BAO/Pledge.php +++ b/CRM/Pledge/BAO/Pledge.php @@ -24,19 +24,13 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { public static $_exportableFields = NULL; /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { + CRM_Core_Error::deprecatedFunctionWarning('API'); return self::commonRetrieve(self::class, $params, $defaults); } diff --git a/CRM/Pledge/BAO/PledgeBlock.php b/CRM/Pledge/BAO/PledgeBlock.php index 3a38a8e2c4..37411474cc 100644 --- a/CRM/Pledge/BAO/PledgeBlock.php +++ b/CRM/Pledge/BAO/PledgeBlock.php @@ -17,17 +17,10 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index fc00d8f7ac..b00548b684 100644 --- a/CRM/Pledge/BAO/PledgePayment.php +++ b/CRM/Pledge/BAO/PledgePayment.php @@ -177,17 +177,10 @@ WHERE pledge_id = %1 } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index f0163d150f..9ff1d0cc93 100644 --- a/CRM/Price/BAO/PriceField.php +++ b/CRM/Price/BAO/PriceField.php @@ -170,17 +170,10 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Price/BAO/PriceFieldValue.php b/CRM/Price/BAO/PriceFieldValue.php index 70e150d500..e267621e07 100644 --- a/CRM/Price/BAO/PriceFieldValue.php +++ b/CRM/Price/BAO/PriceFieldValue.php @@ -105,17 +105,10 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index a5840caee4..ec714e2aeb 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -69,17 +69,10 @@ class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet { } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/CRM/Report/BAO/ReportInstance.php b/CRM/Report/BAO/ReportInstance.php index 1554cc0cce..1bbae23cbf 100644 --- a/CRM/Report/BAO/ReportInstance.php +++ b/CRM/Report/BAO/ReportInstance.php @@ -244,17 +244,10 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance implem } /** - * Retrieve DB object and copy to defaults array. - * + * @deprecated * @param array $params - * Array of criteria values. * @param array $defaults - * Array to be populated with found values. - * * @return self|null - * The DAO object, if found. - * - * @deprecated */ public static function retrieve($params, &$defaults) { return self::commonRetrieve(self::class, $params, $defaults); diff --git a/tests/phpunit/CRM/Financial/BAO/FinancialItemTest.php b/tests/phpunit/CRM/Financial/BAO/FinancialItemTest.php index 86226a8509..4f54cf0360 100644 --- a/tests/phpunit/CRM/Financial/BAO/FinancialItemTest.php +++ b/tests/phpunit/CRM/Financial/BAO/FinancialItemTest.php @@ -77,45 +77,6 @@ class CRM_Financial_BAO_FinancialItemTest extends CiviUnitTestCase { $this->assertEquals($result, $price, 'Verify Amount for Financial Item'); } - /** - * Check method retrieve() - * - * @throws \CRM_Core_Exception - */ - public function testRetrieve(): void { - $price = 100.00; - - $contribution = $this->callAPISuccess('Contribution', 'create', [ - 'contact_id' => $this->individualCreate(), - 'total_amount' => $price, - 'financial_type_id' => 1, - 'is_active' => 1, - 'skipLineItem' => 1, - ]); - $lParams = [ - 'entity_id' => $contribution['id'], - 'entity_table' => 'civicrm_contribution', - 'price_field_id' => 1, - 'qty' => 1, - 'label' => 'Contribution Amount', - 'unit_price' => $price, - 'line_total' => $price, - 'price_field_value_id' => 1, - 'financial_type_id' => 1, - ]; - - $contributionObj = $this->getContributionObject($contribution['id']); - $lineItem = CRM_Price_BAO_LineItem::create($lParams); - CRM_Financial_BAO_FinancialItem::add($lineItem, $contributionObj); - $values = []; - $fParams = [ - 'entity_id' => $lineItem->id, - 'entity_table' => 'civicrm_line_item', - ]; - $financialItem = CRM_Financial_BAO_FinancialItem::retrieve($fParams, $values); - $this->assertEquals($financialItem->amount, $price, 'Verify financial item amount.'); - } - /** * Check method create() * diff --git a/tests/phpunit/CRM/Member/BAO/MembershipStatusTest.php b/tests/phpunit/CRM/Member/BAO/MembershipStatusTest.php index f7eaabbdef..0d06eee9f2 100644 --- a/tests/phpunit/CRM/Member/BAO/MembershipStatusTest.php +++ b/tests/phpunit/CRM/Member/BAO/MembershipStatusTest.php @@ -42,57 +42,6 @@ class CRM_Member_BAO_MembershipStatusTest extends CiviUnitTestCase { $this->assertEquals($result, 'added', 'Verify membership status is_active.'); } - public function testRetrieve() { - - $params = ['name' => 'testStatus', 'is_active' => 1]; - - $this->ids['MembershipStatus'][0] = $this->callAPISuccess('MembershipStatus', 'create', $params)['id']; - $defaults = []; - $result = CRM_Member_BAO_MembershipStatus::retrieve($params, $defaults); - $this->assertEquals($result->name, 'testStatus', 'Verify membership status name.'); - } - - public function testPseudoConstantflush() { - $params = [ - 'name' => 'testStatus', - 'is_active' => 1, - ]; - $this->ids['MembershipStatus'][0] = $this->callAPISuccess('MembershipStatus', 'create', $params)['id']; - $defaults = []; - $result = CRM_Member_BAO_MembershipStatus::retrieve($params, $defaults); - $this->assertEquals($result->name, 'testStatus', 'Verify membership status name.'); - $updateParams = [ - 'id' => $this->ids['MembershipStatus'][0], - 'name' => 'testStatus', - 'label' => 'Changed Status', - 'is_active' => 1, - ]; - $this->callAPISuccess('MembershipStatus', 'create', $updateParams)['id']; - $result = CRM_Member_PseudoConstant::membershipStatus($this->ids['MembershipStatus'][0], NULL, 'label', FALSE, FALSE); - $this->assertEquals($result, 'Changed Status', 'Verify updated membership status label From PseudoConstant.'); - } - - public function testGetMembershipStatus() { - $params = [ - 'name' => 'added', - 'is_active' => 1, - ]; - - $this->ids['MembershipStatus'][0] = $this->callAPISuccess('MembershipStatus', 'create', $params)['id']; - $result = CRM_Member_BAO_MembershipStatus::getMembershipStatus($this->ids['MembershipStatus'][0]); - $this->assertEquals($result['name'], 'added', 'Verify membership status name.'); - } - - public function testDel() { - $params = ['name' => 'testStatus', 'is_active' => 1]; - - $membershipID = $this->callAPISuccess('MembershipStatus', 'create', $params)['id']; - CRM_Member_BAO_MembershipStatus::deleteRecord(['id' => $membershipID]); - $defaults = []; - $result = CRM_Member_BAO_MembershipStatus::retrieve($params, $defaults); - $this->assertEquals($result === NULL, TRUE, 'Verify membership status record deletion.'); - } - /** * @throws \CRM_Core_Exception */ diff --git a/tests/phpunit/CRM/Pledge/BAO/PledgeTest.php b/tests/phpunit/CRM/Pledge/BAO/PledgeTest.php index 8357c4930f..e0f2519b00 100644 --- a/tests/phpunit/CRM/Pledge/BAO/PledgeTest.php +++ b/tests/phpunit/CRM/Pledge/BAO/PledgeTest.php @@ -76,36 +76,6 @@ class CRM_Pledge_BAO_PledgeTest extends CiviUnitTestCase { $this->assertEquals($payment['scheduled_date'], date('Y-m-d 00:00:00', strtotime($scheduledDate))); } - /** - * Test that payment retrieve works based on known pledge id. - */ - public function testRetrieveKnownPledgeID(): void { - $params = [ - 'contact_id' => $this->ids['Contact'][0], - 'frequency_unit' => 'month', - 'frequency_interval' => 1, - 'frequency_day' => 1, - 'original_installment_amount' => 25.00, - 'installments' => 12, - 'financial_type_id' => 1, - 'create_date' => '20100513000000', - 'acknowledge_date' => '20100513000000', - 'start_date' => '20100513000000', - 'status_id' => 2, - 'currency' => 'USD', - 'amount' => 300, - ]; - - $pledge = $this->callAPISuccess('Pledge', 'create', $params); - - $defaults = []; - $pledgeParams = ['pledge_id' => $pledge['id']]; - - $pledgeId = CRM_Pledge_BAO_Pledge::retrieve($pledgeParams, $defaults); - - $this->assertEquals(1, $pledgeId->N, 'Pledge was retrieved'); - } - /** * Test build recur params. */ -- 2.25.1