Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06a1bc01 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | require_once 'CiviTest/CiviUnitTestCase.php'; | |
29 | ||
30 | /** | |
31 | * Test class for Pledge API - civicrm_pledge_* | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | */ | |
35 | class api_v3_PledgeTest extends CiviUnitTestCase { | |
36 | ||
37 | /** | |
38 | * Assume empty database with just civicrm_data | |
39 | */ | |
40 | protected $_individualId; | |
41 | protected $_pledge; | |
42 | protected $_apiversion; | |
43 | protected $_params; | |
44 | protected $_entity; | |
45 | protected $scheduled_date; | |
46 | public $DBResetRequired = True; | |
6a488035 | 47 | |
00be9182 | 48 | public function setUp() { |
6a488035 TO |
49 | $this->_apiversion = 3; |
50 | parent::setUp(); | |
51 | $this->quickCleanup(array('civicrm_pledge', 'civicrm_pledge_payment')); | |
52 | //need to set scheduled payment in advance we are running test @ midnight & it becomes unexpectedly overdue | |
53 | //due to timezone issues | |
54 | $this->scheduled_date = date('Ymd', mktime(0, 0, 0, date("m"), date("d") + 2, date("y"))); | |
55 | $this->_entity = 'Pledge'; | |
e4d5f1e2 | 56 | $this->_individualId = $this->individualCreate(); |
6a488035 TO |
57 | $this->_params = array( |
58 | 'contact_id' => $this->_individualId, | |
59 | 'pledge_create_date' => date('Ymd'), | |
60 | 'start_date' => date('Ymd'), | |
61 | 'scheduled_date' => $this->scheduled_date, | |
62 | 'amount' => 100.00, | |
63 | 'pledge_status_id' => '2', | |
64 | 'pledge_financial_type_id' => '1', | |
65 | 'pledge_original_installment_amount' => 20, | |
66 | 'frequency_interval' => 5, | |
67 | 'frequency_unit' => 'year', | |
68 | 'frequency_day' => 15, | |
69 | 'installments' => 5, | |
70 | 'sequential' => 1, | |
6a488035 TO |
71 | ); |
72 | } | |
73 | ||
00be9182 | 74 | public function tearDown() { |
6a488035 TO |
75 | $this->contactDelete($this->_individualId); |
76 | } | |
77 | ||
78 | ///////////////// civicrm_pledge_get methods | |
79 | ||
80 | /** | |
100fef9d | 81 | * Check with complete array + custom field |
6a488035 TO |
82 | * Note that the test is written on purpose without any |
83 | * variables specific to participant so it can be replicated into other entities | |
84 | * and / or moved to the automated test suite | |
85 | */ | |
00be9182 | 86 | public function testCreateWithCustom() { |
6a488035 TO |
87 | $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); |
88 | ||
89 | $params = $this->_params; | |
90 | $params['custom_' . $ids['custom_field_id']] = "custom string"; | |
91 | ||
7fbb4198 | 92 | $result = $this->callAPISuccess($this->_entity, 'create', $params); |
6a488035 TO |
93 | $this->assertAPISuccess($result, " testCreateWithCustom "); |
94 | $this->assertAPISuccess($result, ' in line ' . __LINE__); | |
7fbb4198 | 95 | $getparams = array('id' => $result['id'], 'return.custom_' . $ids['custom_field_id'] => 1); |
96 | $check = $this->callAPISuccess($this->_entity, 'get', $getparams); | |
97 | $this->callAPISuccess('pledge', 'delete', array('id' => $check['id'])); | |
6a488035 TO |
98 | $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__); |
99 | ||
100 | $this->customFieldDelete($ids['custom_field_id']); | |
101 | $this->customGroupDelete($ids['custom_group_id']); | |
102 | } | |
103 | ||
104 | /* | |
105 | * | |
106 | */ | |
00be9182 | 107 | public function testgetfieldspledge() { |
7fbb4198 | 108 | $result = $this->callAPISuccess('pledge', 'getfields', array('action' => 'get')); |
6a488035 TO |
109 | $this->assertEquals(1, $result['values']['next_pay_date']['api.return']); |
110 | } | |
111 | ||
00be9182 | 112 | public function testGetPledge() { |
6a488035 TO |
113 | |
114 | ||
7fbb4198 | 115 | $this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params); |
6a488035 TO |
116 | $params = array( |
117 | 'pledge_id' => $this->_pledge['id'], | |
6a488035 | 118 | ); |
7fbb4198 | 119 | $result = $this->callAPIAndDocument('pledge', 'get', $params, __FUNCTION__, __FILE__); |
6a488035 | 120 | $pledge = $result['values'][$this->_pledge['id']]; |
6a488035 TO |
121 | $this->assertEquals($this->_individualId, $pledge['contact_id'], 'in line' . __LINE__); |
122 | $this->assertEquals($this->_pledge['id'], $pledge['pledge_id'], 'in line' . __LINE__); | |
123 | $this->assertEquals(date('Y-m-d') . ' 00:00:00', $pledge['pledge_create_date'], 'in line' . __LINE__); | |
124 | $this->assertEquals(100.00, $pledge['pledge_amount'], 'in line' . __LINE__); | |
125 | $this->assertEquals('Pending', $pledge['pledge_status'], 'in line' . __LINE__); | |
126 | $this->assertEquals(5, $pledge['pledge_frequency_interval'], 'in line' . __LINE__); | |
127 | $this->assertEquals('year', $pledge['pledge_frequency_unit'], 'in line' . __LINE__); | |
128 | $this->assertEquals(date('Y-m-d', strtotime($this->scheduled_date)) . ' 00:00:00', $pledge['pledge_next_pay_date'], 'in line' . __LINE__); | |
129 | $this->assertEquals($pledge['pledge_next_pay_amount'], 20.00, 'in line' . __LINE__); | |
130 | ||
131 | $params2 = array( | |
7fbb4198 | 132 | 'pledge_id' => $this->_pledge['id'], ); |
133 | $pledge = $this->callAPISuccess('pledge', 'delete', $params2); | |
6a488035 TO |
134 | } |
135 | /** | |
100fef9d | 136 | * Test 'return.pledge_financial_type' => 1 works |
6a488035 | 137 | */ |
00be9182 | 138 | public function testGetPledgewithReturn() { |
6a488035 | 139 | |
7fbb4198 | 140 | $this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params); |
6a488035 | 141 | $params = array( |
7fbb4198 | 142 | 'pledge_id' => $this->_pledge['id'], 'return.pledge_financial_type' => 1, |
6a488035 | 143 | ); |
7fbb4198 | 144 | $result = $this->callAPISuccess('pledge', 'get', $params); |
6a488035 | 145 | $pledge = $result['values'][$this->_pledge['id']]; |
7fbb4198 | 146 | $this->callAPISuccess('pledge', 'delete', $pledge); |
6a488035 TO |
147 | $this->assertEquals('Donation', $pledge['pledge_financial_type']); |
148 | } | |
149 | /** | |
100fef9d | 150 | * Test 'return.pledge_contribution_type' => 1 works |
6a488035 TO |
151 | * This is for legacy compatibility |
152 | */ | |
00be9182 | 153 | public function testGetPledgewithReturnLegacy() { |
6a488035 | 154 | |
7fbb4198 | 155 | $this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params); |
6a488035 | 156 | $params = array( |
7fbb4198 | 157 | 'pledge_id' => $this->_pledge['id'], 'return.pledge_financial_type' => 1, |
6a488035 | 158 | ); |
7fbb4198 | 159 | $result = $this->callAPISuccess('pledge', 'get', $params); |
6a488035 | 160 | $pledge = $result['values'][$this->_pledge['id']]; |
7fbb4198 | 161 | $this->callAPISuccess('pledge', 'delete', $pledge); |
6a488035 TO |
162 | $this->assertEquals('Donation', $pledge['pledge_financial_type']); |
163 | } | |
164 | ||
00be9182 | 165 | public function testPledgeGetReturnFilters() { |
7fbb4198 | 166 | $oldPledge = $this->callAPISuccess('pledge', 'create', $this->_params); |
6a488035 TO |
167 | |
168 | $overdueParams = array( | |
169 | 'scheduled_date' => 'first saturday of march last year', | |
170 | 'start_date' => 'first saturday of march last year', | |
171 | ); | |
7fbb4198 | 172 | $oldPledge = $this->callAPISuccess('pledge', 'create', array_merge($this->_params, $overdueParams)); |
6a488035 | 173 | |
7fbb4198 | 174 | $pledgeGetParams = array(); |
175 | $allPledges = $this->callAPISuccess('pledge', 'getcount', $pledgeGetParams); | |
6a488035 TO |
176 | |
177 | $this->assertEquals(2, $allPledges, 'Check we have 2 pledges to place with in line ' . __LINE__); | |
178 | $pledgeGetParams['pledge_start_date_high'] = date('YmdHis', strtotime('2 days ago')); | |
7fbb4198 | 179 | $earlyPledge = $this->callAPIAndDocument('pledge', 'get', $pledgeGetParams, __FUNCTION__, __FILE__, "demonstrates high date filter", "GetFilterHighDate"); |
6a488035 TO |
180 | $this->assertEquals(1, $earlyPledge['count'], ' check only one returned with start date filter in line ' . __LINE__); |
181 | $this->assertEquals($oldPledge['id'], $earlyPledge['id'], ' check correct pledge returned ' . __LINE__); | |
182 | } | |
183 | /* | |
184 | * create 2 pledges - see if we can get by status id | |
185 | */ | |
00be9182 | 186 | public function testGetOverduePledge() { |
6a488035 TO |
187 | $overdueParams = array( |
188 | 'scheduled_date' => 'first saturday of march last year', | |
189 | 'start_date' => 'first saturday of march last year', | |
190 | ); | |
7fbb4198 | 191 | $this->_pledge = $this->callAPISuccess('pledge', 'create', array_merge($this->_params, $overdueParams)); |
192 | $params = array( 'pledge_status_id' => '6', | |
6a488035 | 193 | ); |
7fbb4198 | 194 | $result = $this->callAPISuccess('pledge', 'get', $params); |
195 | $emptyResult = $this->callAPISuccess('pledge', 'get', array( 'pledge_status_id' => '1', | |
6a488035 TO |
196 | )); |
197 | $pledge = $result['values'][$this->_pledge['id']]; | |
7fbb4198 | 198 | $this->callAPISuccess('pledge', 'delete', $pledge); |
6a488035 TO |
199 | $this->assertEquals(1, $result['count']); |
200 | $this->assertEquals(0, $emptyResult['count']); | |
201 | } | |
202 | ||
203 | ||
204 | /* | |
205 | * create 2 pledges - see if we can get by status id | |
206 | */ | |
00be9182 | 207 | public function testSortParamPledge() { |
7fbb4198 | 208 | $pledge1 = $this->callAPISuccess('pledge', 'create', $this->_params); |
6a488035 TO |
209 | $overdueParams = array( |
210 | 'scheduled_date' => 'first saturday of march last year', | |
211 | 'start_date' => 'first saturday of march last year', | |
212 | 'create_date' => 'first saturday of march last year', | |
213 | ); | |
7fbb4198 | 214 | $pledge2 = $this->callAPISuccess('pledge', 'create', array_merge($this->_params, $overdueParams)); |
215 | $params = array( 'pledge_is_test' => 0, | |
6a488035 TO |
216 | 'rowCount' => 1, |
217 | ); | |
7fbb4198 | 218 | $result = $this->callAPISuccess('pledge', 'get', $params); |
6a488035 | 219 | |
7fbb4198 | 220 | $resultSortedAsc = $this->callAPISuccess('pledge', 'get', array( 'rowCount' => 1, |
6a488035 TO |
221 | 'sort' => 'start_date ASC', |
222 | )); | |
7fbb4198 | 223 | $resultSortedDesc = $this->callAPISuccess('pledge', 'get', array( 'rowCount' => 1, |
6a488035 TO |
224 | 'sort' => 'start_date DESC', |
225 | )); | |
226 | ||
227 | $this->assertEquals($pledge1['id'], $result['id'], 'pledge get gets first created pledge in line ' . __LINE__); | |
228 | $this->assertEquals($pledge2['id'], $resultSortedAsc['id'], 'Ascending pledge sort works'); | |
229 | $this->assertEquals($pledge1['id'], $resultSortedDesc['id'], 'Decending pledge sort works'); | |
7fbb4198 | 230 | $this->callAPISuccess('pledge', 'delete', array('id' => $pledge1['id'])); |
231 | $this->callAPISuccess('pledge', 'delete', array('id' => $pledge2['id'])); | |
6a488035 TO |
232 | } |
233 | ||
00be9182 | 234 | public function testCreatePledge() { |
6a488035 | 235 | |
7fbb4198 | 236 | $result = $this->callAPIAndDocument('pledge', 'create', $this->_params, __FUNCTION__, __FILE__); |
6a488035 TO |
237 | $this->assertEquals($result['values'][0]['amount'], 100.00, 'In line ' . __LINE__); |
238 | $this->assertEquals($result['values'][0]['installments'], 5, 'In line ' . __LINE__); | |
239 | $this->assertEquals($result['values'][0]['frequency_unit'], 'year', 'In line ' . __LINE__); | |
240 | $this->assertEquals($result['values'][0]['frequency_interval'], 5, 'In line ' . __LINE__); | |
241 | $this->assertEquals($result['values'][0]['frequency_day'], 15, 'In line ' . __LINE__); | |
242 | $this->assertEquals($result['values'][0]['original_installment_amount'], 20, 'In line ' . __LINE__); | |
243 | $this->assertEquals($result['values'][0]['status_id'], 2, 'In line ' . __LINE__); | |
244 | $this->assertEquals($result['values'][0]['create_date'], date('Ymd') . '000000', 'In line ' . __LINE__); | |
245 | $this->assertEquals($result['values'][0]['start_date'], date('Ymd') . '000000', 'In line ' . __LINE__); | |
791c263c | 246 | $this->assertAPISuccess($result, 'In line ' . __LINE__); |
7fbb4198 | 247 | $payments = $this->callAPISuccess('PledgePayment', 'Get', array('pledge_id' => $result['id'], 'sequential' => 1)); |
6a488035 TO |
248 | $this->assertAPISuccess($payments, 'In line ' . __LINE__); |
249 | $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__); | |
250 | require_once 'CRM/Utils/Date.php'; | |
251 | $shouldBeDate = CRM_Utils_Date::format(CRM_Utils_Date::intervalAdd('year', 5 * 4, $this->scheduled_date), "-"); | |
252 | $this->assertEquals(substr($shouldBeDate, 0, 10), substr($payments['values'][4]['scheduled_date'], 0, 10), 'In line ' . __LINE__); | |
253 | ||
7fbb4198 | 254 | $pledgeID = array('id' => $result['id']); |
255 | $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); | |
6a488035 TO |
256 | } |
257 | ||
258 | /* | |
259 | * Test that pledge with weekly schedule calculates dates correctly | |
260 | */ | |
00be9182 | 261 | public function testCreatePledgeWeeklySchedule() { |
6a488035 TO |
262 | $params = array( |
263 | 'scheduled_date' => '20110510', | |
264 | 'frequency_unit' => 'week', | |
265 | 'frequency_day' => 3, | |
266 | 'frequency_interval' => 2, | |
267 | ); | |
268 | $params = array_merge($this->_params, $params); | |
7fbb4198 | 269 | $pledge = $this->callAPISuccess('Pledge', 'Create', $params); |
6a488035 | 270 | //ensure that correct number of payments created & last payment has the right date |
7fbb4198 | 271 | $payments = $this->callAPISuccess('PledgePayment', 'Get', array( |
6a488035 TO |
272 | 'pledge_id' => $pledge['id'], |
273 | 'sequential' => 1)); | |
6a488035 | 274 | $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__); |
6a488035 TO |
275 | $this->assertEquals('2011-07-06 00:00:00', $payments['values'][4]['scheduled_date'], 'In line ' . __LINE__); |
276 | ||
7fbb4198 | 277 | $this->callAPISuccess('pledge', 'delete', array('pledge_id' => $pledge['id'])); |
6a488035 TO |
278 | } |
279 | /* | |
280 | * Test that pledge with weekly schedule calculates dates correctly | |
281 | */ | |
00be9182 | 282 | public function testCreatePledgeMontlySchedule() { |
6a488035 TO |
283 | $params = array( |
284 | 'scheduled_date' => '20110510', | |
285 | 'frequency_unit' => 'Month', | |
286 | 'frequency_day' => 3, | |
287 | 'frequency_interval' => 2, | |
288 | ); | |
289 | $params = array_merge($this->_params, $params); | |
7fbb4198 | 290 | $apiResult = $this->callAPISuccess('pledge', 'create', $params); |
6a488035 TO |
291 | } |
292 | ||
293 | ||
c490a46a CW |
294 | /** |
295 | * Test creation of pledge with only one payment. | |
296 | * | |
297 | * Pledge status id left empty as it is not a required field | |
298 | * http://issues.civicrm.org/jira/browse/CRM-8551 | |
299 | * | |
300 | */ | |
00be9182 | 301 | public function testCreatePledgeSinglePayment() { |
6a488035 TO |
302 | $params = array( |
303 | 'scheduled_date' => '20110510', | |
304 | 'frequency_unit' => 'week', | |
305 | 'frequency_day' => 3, | |
306 | 'frequency_interval' => 2, | |
307 | 'installments' => 1, | |
308 | ); | |
309 | ||
310 | $params = array_merge($this->_params, $params); | |
311 | unset($params['pledge_status_id']); | |
7fbb4198 | 312 | $pledge = $this->callAPISuccess('Pledge', 'Create', $params); |
6a488035 | 313 | //ensure that correct number of payments created & last payment has the right date |
7fbb4198 | 314 | $payments = $this->callAPISuccess('PledgePayment', 'Get', array( |
6a488035 TO |
315 | 'pledge_id' => $pledge['id'], |
316 | 'sequential' => 1 | |
317 | )); | |
6a488035 TO |
318 | $this->assertEquals(1, $payments['count'], 'In line ' . __LINE__); |
319 | $this->assertEquals(2, $payments['values'][0]['status_id'], 'In line ' . __LINE__); | |
7fbb4198 | 320 | $pledgeID = array('id' => $pledge['id']); |
321 | $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); | |
6a488035 TO |
322 | } |
323 | ||
324 | /* | |
325 | * test that using original_installment_amount rather than pledge_original_installment_amount works | |
326 | * Pledge field behaviour is a bit random & so pledge has come to try to handle both unique & non -unique fields | |
327 | */ | |
00be9182 | 328 | public function testCreatePledgeWithNonUnique() { |
6a488035 TO |
329 | $params = $this->_params; |
330 | $params['original_installment_amount'] = $params['pledge_original_installment_amount']; | |
331 | ||
332 | unset($params['pledge_original_installment_amount']); | |
7fbb4198 | 333 | $result = $this->callAPISuccess('pledge', 'create', $params); |
334 | $pledgeDetails = $this->callAPISuccess('Pledge', 'Get', array('id' => $result['id'], 'sequential' => 1)); | |
335 | $pledge = $pledgeDetails['values'][0]; | |
6a488035 TO |
336 | $this->assertEquals(100.00, $pledge['pledge_amount'], 'In line ' . __LINE__); |
337 | $this->assertEquals('year', $pledge['pledge_frequency_unit'], 'In line ' . __LINE__); | |
338 | $this->assertEquals(5, $pledge['pledge_frequency_interval'], 'In line ' . __LINE__); | |
339 | $this->assertEquals(20, $pledge['pledge_next_pay_amount'], 'In line ' . __LINE__); | |
340 | ||
7fbb4198 | 341 | $pledgeID = array('id' => $result['id']); |
342 | $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); | |
6a488035 TO |
343 | } |
344 | ||
00be9182 | 345 | public function testCreateCancelPledge() { |
6a488035 TO |
346 | |
347 | ||
7fbb4198 | 348 | $result = $this->callAPISuccess('pledge', 'create', $this->_params); |
6a488035 | 349 | $this->assertEquals(2, $result['values'][0]['status_id'], "in line " . __LINE__); |
7fbb4198 | 350 | $cancelparams = array('sequential' => 1, 'id' => $result['id'], 'pledge_status_id' => 3); |
351 | $result = $this->callAPISuccess('pledge', 'create', $cancelparams); | |
6a488035 | 352 | $this->assertEquals(3, $result['values'][0]['status_id'], "in line " . __LINE__); |
7fbb4198 | 353 | $pledgeID = array('id' => $result['id']); |
354 | $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); | |
6a488035 TO |
355 | } |
356 | ||
c490a46a | 357 | /** |
100fef9d | 358 | * Test that status is set to pending |
c490a46a | 359 | */ |
00be9182 | 360 | public function testCreatePledgeNoStatus() { |
6a488035 TO |
361 | |
362 | $params = $this->_params; | |
363 | unset($params['status_id']); | |
364 | unset($params['pledge_status_id']); | |
7fbb4198 | 365 | $result = $this->callAPISuccess('pledge', 'create', $params); |
6a488035 TO |
366 | $this->assertAPISuccess($result, "in line " . __LINE__); |
367 | $this->assertEquals(2, $result['values'][0]['status_id'], "in line " . __LINE__); | |
7fbb4198 | 368 | $pledgeID = array('pledge_id' => $result['id']); |
369 | $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); | |
6a488035 TO |
370 | } |
371 | ||
c490a46a CW |
372 | /** |
373 | * To Update Pledge | |
374 | */ | |
00be9182 | 375 | public function testCreateUpdatePledge() { |
6a488035 TO |
376 | // we test 'sequential' param here too |
377 | $pledgeID = $this->pledgeCreate($this->_individualId); | |
378 | $old_params = array( | |
379 | 'id' => $pledgeID, | |
7fbb4198 | 380 | 'sequential' => 1, ); |
381 | $original = $this->callAPISuccess('pledge', 'get', $old_params); | |
6a488035 TO |
382 | //Make sure it came back |
383 | $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID, 'In line ' . __LINE__); | |
384 | //set up list of old params, verify | |
385 | $old_contact_id = $original['values'][0]['contact_id']; | |
386 | $old_frequency_unit = $original['values'][0]['pledge_frequency_unit']; | |
387 | $old_frequency_interval = $original['values'][0]['pledge_frequency_interval']; | |
388 | $old_status_id = $original['values'][0]['pledge_status']; | |
389 | ||
390 | ||
391 | //check against values in CiviUnitTestCase::createPledge() | |
392 | $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__); | |
393 | $this->assertEquals($old_frequency_unit, 'year', 'In line ' . __LINE__); | |
394 | $this->assertEquals($old_frequency_interval, 5, 'In line ' . __LINE__); | |
395 | $this->assertEquals($old_status_id, 'Pending', 'In line ' . __LINE__); | |
396 | $params = array( | |
397 | 'id' => $pledgeID, | |
398 | 'contact_id' => $this->_individualId, | |
399 | 'pledge_status_id' => 3, | |
400 | 'amount' => 100, | |
401 | 'financial_type_id' => 1, | |
402 | 'start_date' => date('Ymd'), | |
7fbb4198 | 403 | 'installments' => 10, ); |
6a488035 | 404 | |
7fbb4198 | 405 | $pledge = $this->callAPISuccess('pledge', 'create', $params); |
6a488035 TO |
406 | $new_params = array( |
407 | 'id' => $pledge['id'], | |
6a488035 | 408 | ); |
7fbb4198 | 409 | $pledge = $this->callAPISuccess('pledge', 'get', $new_params); |
6a488035 TO |
410 | $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId, 'In line ' . __LINE__); |
411 | $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__); | |
7fbb4198 | 412 | $pledge = $this->callAPISuccess('pledge', 'delete', $new_params); |
6a488035 | 413 | } |
c490a46a CW |
414 | |
415 | /** | |
416 | * Here we ensure we are maintaining our 'contract' & supporting previously working syntax | |
417 | * ie contribution_type_id | |
418 | */ | |
00be9182 | 419 | public function testCreateUpdatePledgeLegacy() { |
6a488035 TO |
420 | |
421 | // we test 'sequential' param here too | |
422 | $pledgeID = $this->pledgeCreate($this->_individualId); | |
423 | $old_params = array( | |
424 | 'id' => $pledgeID, | |
7fbb4198 | 425 | 'sequential' => 1, ); |
426 | $original = $this->callAPISuccess('pledge', 'get', $old_params); | |
6a488035 TO |
427 | //Make sure it came back |
428 | $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID, 'In line ' . __LINE__); | |
429 | //set up list of old params, verify | |
430 | $old_contact_id = $original['values'][0]['contact_id']; | |
431 | $old_frequency_unit = $original['values'][0]['pledge_frequency_unit']; | |
432 | $old_frequency_interval = $original['values'][0]['pledge_frequency_interval']; | |
433 | $old_status_id = $original['values'][0]['pledge_status']; | |
434 | ||
435 | ||
436 | //check against values in CiviUnitTestCase::createPledge() | |
437 | $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__); | |
438 | $this->assertEquals($old_frequency_unit, 'year', 'In line ' . __LINE__); | |
439 | $this->assertEquals($old_frequency_interval, 5, 'In line ' . __LINE__); | |
440 | $this->assertEquals($old_status_id, 'Pending', 'In line ' . __LINE__); | |
441 | $params = array( | |
442 | 'id' => $pledgeID, | |
443 | 'contact_id' => $this->_individualId, | |
444 | 'pledge_status_id' => 3, | |
445 | 'amount' => 100, | |
446 | 'contribution_type_id' => 1, | |
447 | 'start_date' => date('Ymd'), | |
448 | 'installments' => 10, | |
6a488035 TO |
449 | ); |
450 | ||
7fbb4198 | 451 | $pledge = $this->callAPISuccess('pledge', 'create', $params); |
6a488035 TO |
452 | $new_params = array( |
453 | 'id' => $pledge['id'], | |
6a488035 | 454 | ); |
7fbb4198 | 455 | $pledge = $this->callAPISuccess('pledge', 'get', $new_params); |
6a488035 TO |
456 | $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId, 'In line ' . __LINE__); |
457 | $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__); | |
7fbb4198 | 458 | $pledge = $this->callAPISuccess('pledge', 'delete', $new_params); |
6a488035 TO |
459 | } |
460 | ||
461 | ///////////////// civicrm_pledge_delete methods | |
00be9182 | 462 | public function testDeleteEmptyParamsPledge() { |
7fbb4198 | 463 | $pledge = $this->callAPIFailure('pledge', 'delete', array(), 'Mandatory key(s) missing from params array: id'); |
6a488035 TO |
464 | } |
465 | ||
6a488035 | 466 | |
00be9182 | 467 | public function testDeleteWrongParamPledge() { |
6a488035 TO |
468 | $params = array( |
469 | 'pledge_source' => 'SSF', | |
6a488035 | 470 | ); |
7fbb4198 | 471 | $pledge = $this->callAPIFailure('pledge', 'delete', $params, 'Mandatory key(s) missing from params array: id'); |
6a488035 TO |
472 | } |
473 | ||
c490a46a | 474 | /** |
100fef9d | 475 | * Legacy support for pledge_id |
c490a46a | 476 | */ |
00be9182 | 477 | public function testDeletePledge() { |
6a488035 TO |
478 | |
479 | $pledgeID = $this->pledgeCreate($this->_individualId); | |
480 | $params = array( | |
481 | 'pledge_id' => $pledgeID, | |
6a488035 | 482 | ); |
7fbb4198 | 483 | $result = $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__, __FILE__); |
6a488035 TO |
484 | } |
485 | ||
c490a46a | 486 | /** |
100fef9d | 487 | * Std is to accept id |
c490a46a | 488 | */ |
00be9182 | 489 | public function testDeletePledgeUseID() { |
6a488035 TO |
490 | |
491 | $pledgeID = $this->pledgeCreate($this->_individualId); | |
492 | $params = array( | |
493 | 'id' => $pledgeID, | |
6a488035 | 494 | ); |
7fbb4198 | 495 | $result = $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__, __FILE__); |
6a488035 | 496 | } |
c490a46a CW |
497 | |
498 | /** | |
100fef9d | 499 | * Test to make sure empty get returns nothing |
c490a46a CW |
500 | * Note that the function gives incorrect results if no pledges exist as it does a |
501 | * contact search instead - test only checks that the get finds the one existing | |
502 | */ | |
00be9182 | 503 | public function testGetEmpty() { |
7fbb4198 | 504 | $result = $this->callAPISuccess('pledge', 'create', $this->_params); |
505 | $result = $this->callAPISuccess('pledge', 'get', array()); | |
6a488035 TO |
506 | $this->assertAPISuccess($result, "This test is failing because it's acting like a contact get when no params set. Not sure the fix"); |
507 | $this->assertEquals(1, $result['count'], 'in line ' . __LINE__); | |
7fbb4198 | 508 | $pledgeID = array('id' => $result['id']); |
509 | $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID); | |
6a488035 TO |
510 | } |
511 | } |