3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
28 require_once 'CiviTest/CiviUnitTestCase.php';
31 * Test class for Pledge API - civicrm_pledge_*
33 * @package CiviCRM_APIv3
36 class api_v3_PledgePaymentTest
extends CiviUnitTestCase
{
39 * Assume empty database with just civicrm_data
41 protected $_individualId;
43 protected $_apiversion = 3;
44 protected $_contributionID;
45 protected $_financialTypeId = 1;
46 protected $_entity = 'PledgePayment';
47 public $DBResetRequired = TRUE;
51 $this->_individualId
= $this->individualCreate();
52 $this->_pledgeID
= $this->pledgeCreate($this->_individualId
);
53 $this->_contributionID
= $this->contributionCreate($this->_individualId
);
57 $tablesToTruncate = array(
58 'civicrm_contribution',
61 'civicrm_pledge_payment',
65 $this->quickCleanup($tablesToTruncate);
68 function testGetPledgePayment() {
70 $result = $this->callAPIAndDocument('pledge_payment', 'get', $params, __FUNCTION__
, __FILE__
);
71 $this->assertEquals(5, $result['count'], " in line " . __LINE__
);
75 * Test that passing in a single variable works
77 function testGetSinglePledgePayment() {
80 $createparams = array(
81 'contact_id' => $this->_individualId
,
82 'pledge_id' => $this->_pledgeID
,
83 'contribution_id' => $this->_contributionID
,
86 $createResult = $this->callAPISuccess('pledge_payment', 'create', $createparams);
88 'contribution_id' => $this->_contributionID
,
90 $result = $this->callAPISuccess('pledge_payment', 'get', $params);
91 $this->assertEquals(1, $result['count'], " in line " . __LINE__
);
95 * Test that passing in a single variable works:: status_id
97 function testGetSinglePledgePaymentByStatusID() {
100 $createparams = array(
101 'contact_id' => $this->_individualId
,
102 'pledge_id' => $this->_pledgeID
,
103 'contribution_id' => $this->_contributionID
,
106 $createResult = $this->callAPISuccess('pledge_payment', 'create', $createparams);
111 $result = $this->callAPISuccess('pledge_payment', 'get', $params);
112 $this->assertEquals(1, $result['count'], " in line " . __LINE__
);
116 * Test that creating a payment will add the contribution ID
118 function testCreatePledgePayment() {
119 //check that 5 pledge payments exist at the start
120 $beforeAdd = $this->callAPISuccess('pledge_payment', 'get', array());
121 $this->assertEquals(5, $beforeAdd['count'], " in line " . __LINE__
);
123 //test the pledge_payment_create function
125 'contact_id' => $this->_individualId
,
126 'pledge_id' => $this->_pledgeID
,
127 'contribution_id' => $this->_contributionID
,
129 'actual_amount' => 20,
131 $result = $this->callAPIAndDocument('pledge_payment', 'create', $params, __FUNCTION__
, __FILE__
);
133 //check existing updated not new one created - 'create' means add contribution_id in this context
134 $afterAdd = $this->callAPISuccess('pledge_payment', 'get', array());
135 $this->assertEquals(5, $afterAdd['count'], " in line " . __LINE__
);
137 //get the created payment & check it out
138 $getParams['id'] = $result['id'];
139 $getIndPayment = $this->callAPISuccess('pledge_payment', 'get', $getParams);
140 $this->assertEquals(1, $getIndPayment['count'], " in line " . __LINE__
);
141 $this->assertEquals(20, $getIndPayment['values'][$result['id']]['actual_amount'], " in line " . __LINE__
);
143 //create a second pledge payment - need a contribution first &can't use the CiviUnitTest case function as invoice is hard-coded
144 $contributionParams = array(
145 'total_amount' => 20,
146 'contact_id' => $this->_individualId
,
147 'financial_type_id' => $this->_financialTypeId
,
149 $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
150 $params['contribution_id'] = $contribution['id'];
153 $resultCont2 = $this->callAPISuccess('pledge_payment', 'create', $params);
154 //make sure original is untouched & has not been updated
155 $this->assertGreaterThan($result['id'], $resultCont2['id'], " in line " . __LINE__
);
156 $getIndPaymentAgain = $this->callAPISuccess('pledge_payment', 'get', $getParams);
157 $this->assertEquals(1, $getIndPaymentAgain['count'], " in line " . __LINE__
);
158 $this->assertEquals($this->_contributionID
, $getIndPaymentAgain['values'][$result['id']]['contribution_id'], " in line " . __LINE__
);
162 * test checks behaviour when more payments are created than should be possible
164 function testCreatePledgePaymentAllCreated() {
166 'pledge_id' => $this->_pledgeID
,
169 // create one more pledge than there are spaces for
172 $contributionParams = array(
173 'total_amount' => 20,
174 'contact_id' => $this->_individualId
,
175 'financial_type_id' => $this->_financialTypeId
,
177 $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
179 $params['contribution_id'] = $contribution['id'];
181 $resultCont2 = civicrm_api('pledge_payment', 'create', $params +
array('version' => $this->_apiversion
));
184 // check that only 5 exist & we got an error setting the 6th
185 $result = $this->callAPISuccess('PledgePayment', 'Get', array(
186 'pledge_id' => $this->_pledgeID
,
188 // the last one above should result in an error
189 $this->assertEquals("There are no unmatched payment on this pledge. Pass in the pledge_payment id to specify one or 'option.create_new' to create one", $resultCont2['error_message']);
190 $this->assertEquals(5, $result['count']);
192 $params['option.create_new'] = 1;
193 $params['scheduled_amount'] = 20;
194 $params['scheduled_date'] = '20131212';
195 $resultcreatenew = $this->callAPISuccess('pledge_payment', 'create', $params);
196 $result = $this->callAPISuccess('PledgePayment', 'Get', array(
197 'pledge_id' => $this->_pledgeID
,
200 $this->assertEquals(6, $result['count']);
203 * Test that creating a payment will add the contribution ID where only one pledge payment
206 function testCreatePledgePaymentWhereOnlyOnePayment() {
208 $pledgeParams = array(
209 'contact_id' => $this->_individualId
,
210 'pledge_create_date' => date('Ymd'),
211 'start_date' => date('Ymd'),
212 'scheduled_date' => 'first day 2015',
213 'pledge_amount' => 100.00,
214 'pledge_status_id' => '2',
215 'pledge_financial_type_id' => '1',
216 'pledge_original_installment_amount' => 20,
217 'frequency_interval' => 5,
218 'frequency_unit' => 'year',
219 'frequency_day' => 15,
224 $contributionID = $this->contributionCreate($this->_individualId
, $this->_financialTypeId
, 45, 45);
225 $pledge = $this->callAPISuccess('Pledge', 'Create', $pledgeParams);
227 //test the pledge_payment_create function
229 'contact_id' => $this->_individualId
,
230 'pledge_id' => $pledge['id'],
231 'contribution_id' => $contributionID,
233 'actual_amount' => 20,
235 $result = $this->callAPISuccess('pledge_payment', 'create', $params);
237 //check existing updated not new one created - 'create' means add contribution_id in this context
238 $afterAdd = $this->callAPISuccess('pledge_payment', 'get', array(
239 'contribution_id' => $contributionID,
241 $this->assertEquals(1, $afterAdd['count'], " in line " . __LINE__
);
244 function testUpdatePledgePayment() {
246 'pledge_id' => $this->_pledgeID
,
247 'contribution_id' => $this->_contributionID
,
249 'actual_amount' => 20,
251 $result = $this->callAPISuccess('pledge_payment', 'create', $params);
252 $updateparams = array(
253 'id' => $result['id'],
257 $result = $this->callAPIAndDocument('pledge_payment', 'update', $updateparams, __FUNCTION__
, __FILE__
);
258 $this->getAndCheck(array_merge($params,$updateparams), $result['id'], $this->_entity
);
261 function testDeletePledgePayment() {
263 'contact_id' => $this->_individualId
,
264 'pledge_id' => $this->_pledgeID
,
265 'contribution_id' => $this->_contributionID
,
268 'actual_amount' => 20,
270 $pledgePayment = $this->callAPISuccess('pledge_payment', 'create', $params);
272 $deleteParams = array(
273 'id' => $pledgePayment['id'],
275 $result = $this->callAPIAndDocument('pledge_payment', 'delete', $deleteParams, __FUNCTION__
, __FILE__
);
278 function testGetFields() {
279 $result = $this->callAPISuccess('PledgePayment', 'GetFields', array());
280 $this->assertType('array', $result);