REF - Noisily deprecate BAO::retrieve functions
authorColeman Watts <coleman@civicrm.org>
Mon, 3 Apr 2023 00:38:35 +0000 (20:38 -0400)
committerColeman Watts <coleman@civicrm.org>
Mon, 3 Apr 2023 19:26:01 +0000 (15:26 -0400)
43 files changed:
CRM/ACL/BAO/ACL.php
CRM/ACL/BAO/ACLEntityRole.php
CRM/Campaign/BAO/Campaign.php
CRM/Campaign/BAO/Survey.php
CRM/Contact/BAO/ContactType.php
CRM/Contact/BAO/Group.php
CRM/Contact/BAO/RelationshipType.php
CRM/Contribute/BAO/Product.php
CRM/Core/BAO/CustomField.php
CRM/Core/BAO/CustomGroup.php
CRM/Core/BAO/Domain.php
CRM/Core/BAO/Extension.php
CRM/Core/BAO/Job.php
CRM/Core/BAO/LocationType.php
CRM/Core/BAO/MailSettings.php
CRM/Core/BAO/Mapping.php
CRM/Core/BAO/MessageTemplate.php
CRM/Core/BAO/OptionGroup.php
CRM/Core/BAO/OptionValue.php
CRM/Core/BAO/PreferencesDate.php
CRM/Core/BAO/Tag.php
CRM/Core/BAO/UFField.php
CRM/Core/BAO/WordReplacement.php
CRM/Event/BAO/Event.php
CRM/Event/BAO/ParticipantStatusType.php
CRM/Financial/BAO/FinancialItem.php
CRM/Financial/BAO/FinancialType.php
CRM/Financial/BAO/PaymentProcessor.php
CRM/Financial/BAO/PaymentProcessorType.php
CRM/Friend/BAO/Friend.php
CRM/Mailing/BAO/MailingComponent.php
CRM/Member/BAO/MembershipStatus.php
CRM/Member/BAO/MembershipType.php
CRM/Pledge/BAO/Pledge.php
CRM/Pledge/BAO/PledgeBlock.php
CRM/Pledge/BAO/PledgePayment.php
CRM/Price/BAO/PriceField.php
CRM/Price/BAO/PriceFieldValue.php
CRM/Price/BAO/PriceSet.php
CRM/Report/BAO/ReportInstance.php
tests/phpunit/CRM/Financial/BAO/FinancialItemTest.php
tests/phpunit/CRM/Member/BAO/MembershipStatusTest.php
tests/phpunit/CRM/Pledge/BAO/PledgeTest.php

index 2e78ea666fbbab92a19cbb666e909a99bb2dab16..6668ff4e3368737808f79aa99d15aab42e994413 100644 (file)
@@ -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);
   }
 
index 26ae773ad1c28479570a474bd01bf1c299655c4f..65be324ce7cd8cc523d85f0203c0a16a3c679ace 100644 (file)
@@ -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);
   }
 
index ee01e49e3efb276a287cf758b550ebbd4059ef6e..311fc935d6801cb4a8c0c2852ca0f844aa6df7fc 100644 (file)
@@ -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);
   }
 
index 3f42995ee092e33eac2ec982848fec935a05cde4..ba957f8f5b9da8f5ef4b5682412b681947a5c69c 100644 (file)
 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);
index 77eaa894070a747a216275b15459322b6839598a..0ff52f1047ecd1457abf6b3971a608da6109e16f 100644 (file)
 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);
   }
 
index 27c5a65f2fd72ed7e4c1da90fbe63633db20aa63..c718b3ce449cf259f5f54d186172eaa9542c0c32 100644 (file)
@@ -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);
index e74b475c3d112f70137aa7b78d7332dc7d8f33b8..96408eb097ffb252922b36395e16db54cf24ed3f 100644 (file)
@@ -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);
index f4f6f5f4dcbc618c177e734dad9cb242ba139f10..24ba30d8aa211b9c678c6b6b045a44a2e1d19ec2 100644 (file)
@@ -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;
   }
 
   /**
index 5da3581da90d8736618e9f3e298d72bc085c030d..5725f960ead3e6b41b47857dcff25a9320753d58 100644 (file)
@@ -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);
index a4a33744a60c749ccb82fd8efb264ee62ad1da01..586b148d6f29e950f5b372f510febc459ac4bd30 100644 (file)
@@ -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);
index c3642ccbab09b96fd56fc453803a8f3802e00267..b81d5add43bbf5951741dfc9619290799c5e65cc 100644 (file)
@@ -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);
index 4bb87024ed957187ec04f92572e807d56bd66990..9d07e8cb699b6fe2e4230fa4575b491090bab4c2 100644 (file)
 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);
   }
 
index 1f8fd506fbaac79d509a66a0da3ce8f4c8f8d6bb..c281bf8a7110f306d3940e9800e907bd149b5a6d 100644 (file)
@@ -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);
   }
 
index 6493470d3db97857245aac9dcffd5716923de152..0de77f2a66d3a3c3305dedd0048a3facbdb49f34 100644 (file)
@@ -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);
index f0752fb5430fca4ed6876fa05595c2caab35e1f5..7b13eca10882bd79714bb8592cf53a9fc823b88e 100644 (file)
@@ -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);
   }
 
index f184420c330618837a28bfd2231493202527737e..07abc103790329d3bf59147b3c952697a51911cb 100644 (file)
 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);
   }
 
index 9b70920b2d8a619e9ff2a032b2c5a3b424ffe42f..fdf95282051bdc32f54a397110442d70f4ba8075 100644 (file)
@@ -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);
   }
 
index bd3ffe9c3368b13c7965d07223158e6d6204e809..b9a1c99ae828c43222669f8e81dca45198a5522f 100644 (file)
 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);
index 622fca1c20de5709110ddb275cc98ea94adc6f47..a7d3c2562d274884fb22afddc596d4c7b63244e7 100644 (file)
@@ -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);
index 9263f6b230e0c52dd00dbb4d00e8bcd9895164bb..86ff352351efac2873f4a5113e05e4f76ec83b9b 100644 (file)
 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);
   }
 
index 7991e8cb73d145862dd6969bdfc304c7942733a3..152a797c346cea609adb377cedccc35d985d6848 100644 (file)
@@ -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);
   }
 
index 5ade83e12f2b2f945adf0cc5c91fabb60771af78..c34d0ec5484cccd38403fdf654d652de76611452 100644 (file)
@@ -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);
   }
 
index e3429a12b082bfbf301dc48abce2be43e9067d70..2de2135cad0113acef8196edd0b45c198b05879a 100644 (file)
 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);
   }
 
index 6b9154a1734577355a0d0090513ca4c4a61032b2..4cbc3f023be38a636bbbf307eddfb0c077147938 100644 (file)
 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);
index 4c0941166fb70a7abfa5f107fab568ec241935eb..7176dcc48b9e5d38f2aca7dbcd4a9203cb3f36cb 100644 (file)
@@ -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);
index 4e1680d59a18e598df6fe3ad344d16d00fa96dec..4350de8e730e89ae856db021d2231cf4d89119ac 100644 (file)
 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);
   }
 
index bb2cc98d7f0f041d110e330ec2a111f930161c82..a8a47383fe8fee868cce0b529e5dabdf524f0651 100644 (file)
@@ -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);
   }
 
index 986adf5573222904bcfc80d4e94d779b6beaa070..95e7ce293132fdf648434775fdfa204c501248be 100644 (file)
@@ -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);
   }
 
index 356dc2bb59ed8ccf9f3da972f641573fa93f30cc..820200736d083f413b309ee7b0b03e04349d2f9b 100644 (file)
@@ -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);
index 39a090dc78daea2f9068e759426a5a209e4a1afb..6e97730cce8118734d155e3577a7c80618e4070c 100644 (file)
@@ -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);
index 72c75cb63a0b0cbf90fac0070c9ce51c9a01fa3a..f015b5cb91774815327111e130ff741b28b3fdad 100644 (file)
 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);
   }
 
index a2e889541258281398f02408549053fae31a7a83..48175688ff420ed8674026fa9ad0a87a32e87bd0 100644 (file)
 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);
   }
 
index d51f768d7ff558f86eb58a7d711a717dd1560a1e..8e490af173d3738fd17447e7b5731e91ad0d6b3e 100644 (file)
@@ -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);
index 546a9aa29088ffc84bd5e6e7fce615a6e341ce98..f1312cfbf96a3eecf09cfc68a3f4a7bf3464d4a3 100644 (file)
@@ -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);
   }
 
index 3a38a8e2c43741760251d6d98974fdec94e1124c..37411474cc71be3f5b539042ee069fbfd78905df 100644 (file)
 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);
index fc00d8f7ac33edade25590954e50fec82e426b40..b00548b684b495dbaaa20bf715a95b00c5ac9232 100644 (file)
@@ -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);
index f0163d150fe6483c2bf7ce3332106e7564505823..9ff1d0cc931a27aed053e08f7f1861615d7cabaf 100644 (file)
@@ -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);
index 70e150d5001fbae27f558842d2840ed41e299915..e267621e073306629290cd87f09c101b87894525 100644 (file)
@@ -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);
index a5840caee43215d660565cf13d18294a4fa98714..ec714e2aeb4c020633ebe6fd9f2fb6c12ff17f61 100644 (file)
@@ -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);
index 1554cc0cce250d3b0ab4b2779b072597f664b55a..1bbae23cbf8ae73e7d66ebc2eee7d48fdb04ee61 100644 (file)
@@ -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);
index 86226a850977d9f3fed9bdaf5a400e0eb1f88bde..4f54cf03605342434a6561f8b5f48f9ef1d5ccd0 100644 (file)
@@ -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()
    *
index f7eaabbdef1f2227967261d74c412d087a6a1de6..0d06eee9f25c5f6f5053325ade28c21d25cb6660 100644 (file)
@@ -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
    */
index 8357c4930fd25901d92d9cd05770c8ceeab6ede9..e0f2519b00b43e18c27b0242ac5eaa2b8681210f 100644 (file)
@@ -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.
    */