3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
35 class api_v3_PledgePaymentTest
extends CiviUnitTestCase
{
38 * Assume empty database with just civicrm_data
40 protected $_individualId;
42 protected $_apiversion = 3;
43 protected $_contributionID;
44 protected $_financialTypeId = 1;
45 protected $_entity = 'PledgePayment';
46 public $DBResetRequired = TRUE;
48 public function setUp() {
50 $this->_individualId
= $this->individualCreate();
51 $this->_pledgeID
= $this->pledgeCreate($this->_individualId
);
52 $this->_contributionID
= $this->contributionCreate($this->_individualId
);
55 public function tearDown() {
56 $tablesToTruncate = array(
57 'civicrm_contribution',
60 'civicrm_pledge_payment',
64 $this->quickCleanup($tablesToTruncate);
67 public function testGetPledgePayment() {
69 $result = $this->callAPIAndDocument('pledge_payment', 'get', $params, __FUNCTION__
, __FILE__
);
70 $this->assertEquals(5, $result['count'], " in line " . __LINE__
);
74 * Test that passing in a single variable works
76 public function testGetSinglePledgePayment() {
77 $createparams = array(
78 'contact_id' => $this->_individualId
,
79 'pledge_id' => $this->_pledgeID
,
80 'contribution_id' => $this->_contributionID
,
83 $createResult = $this->callAPISuccess('pledge_payment', 'create', $createparams);
85 'contribution_id' => $this->_contributionID
,
87 $result = $this->callAPISuccess('pledge_payment', 'get', $params);
88 $this->assertEquals(1, $result['count'], " in line " . __LINE__
);
92 * Test that passing in a single variable works:: status_id
94 public function testGetSinglePledgePaymentByStatusID() {
95 $createparams = array(
96 'contact_id' => $this->_individualId
,
97 'pledge_id' => $this->_pledgeID
,
98 'contribution_id' => $this->_contributionID
,
101 $createResult = $this->callAPISuccess('pledge_payment', 'create', $createparams);
106 $result = $this->callAPISuccess('pledge_payment', 'get', $params);
107 $this->assertEquals(1, $result['count'], " in line " . __LINE__
);
111 * Test that creating a payment will add the contribution ID
113 public function testCreatePledgePayment() {
114 //check that 5 pledge payments exist at the start
115 $beforeAdd = $this->callAPISuccess('pledge_payment', 'get', array());
116 $this->assertEquals(5, $beforeAdd['count'], " in line " . __LINE__
);
118 //test the pledge_payment_create function
120 'contact_id' => $this->_individualId
,
121 'pledge_id' => $this->_pledgeID
,
122 'contribution_id' => $this->_contributionID
,
124 'actual_amount' => 20,
126 $result = $this->callAPIAndDocument('pledge_payment', 'create', $params, __FUNCTION__
, __FILE__
);
128 //check existing updated not new one created - 'create' means add contribution_id in this context
129 $afterAdd = $this->callAPISuccess('pledge_payment', 'get', array());
130 $this->assertEquals(5, $afterAdd['count'], " in line " . __LINE__
);
132 //get the created payment & check it out
133 $getParams['id'] = $result['id'];
134 $getIndPayment = $this->callAPISuccess('pledge_payment', 'get', $getParams);
135 $this->assertEquals(1, $getIndPayment['count'], " in line " . __LINE__
);
136 $this->assertEquals(20, $getIndPayment['values'][$result['id']]['actual_amount'], " in line " . __LINE__
);
138 //create a second pledge payment - need a contribution first &can't use the CiviUnitTest case function as invoice is hard-coded
139 $contributionParams = array(
140 'total_amount' => 20,
141 'contact_id' => $this->_individualId
,
142 'financial_type_id' => $this->_financialTypeId
,
144 $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
145 $params['contribution_id'] = $contribution['id'];
147 $resultCont2 = $this->callAPISuccess('pledge_payment', 'create', $params);
148 //make sure original is untouched & has not been updated
149 $this->assertGreaterThan($result['id'], $resultCont2['id'], " in line " . __LINE__
);
150 $getIndPaymentAgain = $this->callAPISuccess('pledge_payment', 'get', $getParams);
151 $this->assertEquals(1, $getIndPaymentAgain['count'], " in line " . __LINE__
);
152 $this->assertEquals($this->_contributionID
, $getIndPaymentAgain['values'][$result['id']]['contribution_id'], " in line " . __LINE__
);
156 * Test checks behaviour when more payments are created than should be possible
158 public function testCreatePledgePaymentAllCreated() {
160 'pledge_id' => $this->_pledgeID
,
163 // create one more pledge than there are spaces for
166 $contributionParams = array(
167 'total_amount' => 20,
168 'contact_id' => $this->_individualId
,
169 'financial_type_id' => $this->_financialTypeId
,
171 $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
173 $params['contribution_id'] = $contribution['id'];
175 $resultCont2 = civicrm_api('pledge_payment', 'create', $params +
array('version' => $this->_apiversion
));
178 // check that only 5 exist & we got an error setting the 6th
179 $result = $this->callAPISuccess('PledgePayment', 'Get', array(
180 'pledge_id' => $this->_pledgeID
,
182 // the last one above should result in an error
183 $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']);
184 $this->assertEquals(5, $result['count']);
186 $params['option.create_new'] = 1;
187 $params['scheduled_amount'] = 20;
188 $params['scheduled_date'] = '20131212';
189 $resultcreatenew = $this->callAPISuccess('pledge_payment', 'create', $params);
190 $result = $this->callAPISuccess('PledgePayment', 'Get', array(
191 'pledge_id' => $this->_pledgeID
,
194 $this->assertEquals(6, $result['count']);
198 * Test that creating a payment will add the contribution ID where only one pledge payment
201 public function testCreatePledgePaymentWhereOnlyOnePayment() {
202 $pledgeParams = array(
203 'contact_id' => $this->_individualId
,
204 'pledge_create_date' => date('Ymd'),
205 'start_date' => date('Ymd'),
206 'scheduled_date' => 'first day 2015',
207 'pledge_amount' => 100.00,
208 'pledge_status_id' => '2',
209 'pledge_financial_type_id' => '1',
210 'pledge_original_installment_amount' => 20,
211 'frequency_interval' => 5,
212 'frequency_unit' => 'year',
213 'frequency_day' => 15,
218 $contributionID = $this->contributionCreate($this->_individualId
, $this->_financialTypeId
, 45, 45);
219 $pledge = $this->callAPISuccess('Pledge', 'Create', $pledgeParams);
221 //test the pledge_payment_create function
223 'contact_id' => $this->_individualId
,
224 'pledge_id' => $pledge['id'],
225 'contribution_id' => $contributionID,
227 'actual_amount' => 20,
229 $result = $this->callAPISuccess('pledge_payment', 'create', $params);
231 //check existing updated not new one created - 'create' means add contribution_id in this context
232 $afterAdd = $this->callAPISuccess('pledge_payment', 'get', array(
233 'contribution_id' => $contributionID,
235 $this->assertEquals(1, $afterAdd['count'], " in line " . __LINE__
);
238 public function testUpdatePledgePayment() {
240 'pledge_id' => $this->_pledgeID
,
241 'contribution_id' => $this->_contributionID
,
243 'actual_amount' => 20,
245 $result = $this->callAPISuccess('pledge_payment', 'create', $params);
246 $updateparams = array(
247 'id' => $result['id'],
251 $result = $this->callAPIAndDocument('pledge_payment', 'update', $updateparams, __FUNCTION__
, __FILE__
);
252 $this->getAndCheck(array_merge($params, $updateparams), $result['id'], $this->_entity
);
255 public function testDeletePledgePayment() {
257 'contact_id' => $this->_individualId
,
258 'pledge_id' => $this->_pledgeID
,
259 'contribution_id' => $this->_contributionID
,
262 'actual_amount' => 20,
264 $pledgePayment = $this->callAPISuccess('pledge_payment', 'create', $params);
266 $deleteParams = array(
267 'id' => $pledgePayment['id'],
269 $result = $this->callAPIAndDocument('pledge_payment', 'delete', $deleteParams, __FUNCTION__
, __FILE__
);
272 public function testGetFields() {
273 $result = $this->callAPISuccess('PledgePayment', 'GetFields', array());
274 $this->assertType('array', $result);