}
/**
- * 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);
}
}
/**
- * 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);
}
}
/**
- * 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);
}
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);
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);
}
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);
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);
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;
}
/**
}
/**
- * 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);
}
/**
- * 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);
}
/**
- * 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);
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);
}
}
/**
- * 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);
}
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);
}
/**
- * 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);
}
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);
}
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);
}
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);
}
/**
- * 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);
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);
}
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);
}
}
/**
- * 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);
}
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);
}
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);
}
/**
- * 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);
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);
}
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);
}
}
/**
- * 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);
}
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);
}
/**
- * 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);
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);
}
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);
}
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);
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);
}
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);
}
/**
- * 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);
}
/**
- * 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);
}
/**
- * 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);
}
/**
- * 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);
}
/**
- * 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);
$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()
*
$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
*/
$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.
*/