3 * Class CRM_Event_BAO_AdditionalPaymentTest
6 class CRM_Event_BAO_CRM19273
extends CiviUnitTestCase
{
8 protected $_priceSetID;
9 protected $_cheapFee = 80;
10 protected $_expensiveFee = 100;
11 protected $_veryExpensive = 120;
16 protected $contributionID;
21 protected $participantID;
28 protected $priceSetFieldID;
33 public function setUp() {
36 $this->_contactId
= $this->individualCreate();
37 $event = $this->eventCreate(array('is_monetary' => 1));
38 $this->_eventId
= $event['id'];
39 $this->_priceSetID
= $this->eventPriceSetCreate();
40 CRM_Price_BAO_PriceSet
::addTo('civicrm_event', $this->_eventId
, $this->_priceSetID
);
41 $priceSet = CRM_Price_BAO_PriceSet
::getSetDetail($this->_priceSetID
, TRUE, FALSE);
42 $priceSet = CRM_Utils_Array
::value($this->_priceSetID
, $priceSet);
43 $this->_feeBlock
= CRM_Utils_Array
::value('fields', $priceSet);
44 $this->registerParticipantAndPay();
48 * Clean up after test.
50 public function tearDown() {
51 $this->eventDelete($this->_eventId
);
52 $this->quickCleanUpFinancialEntities();
57 * Remove default price field stuff.
59 * This is not actually good. However resolving this requires
60 * a lot more fixes & we have a bit of work to do on event tests.
64 protected function cleanup() {
67 'civicrm_price_field_value',
68 'civicrm_price_field',
75 * Create an event with a price set.
77 * @todo resolve this with parent function.
83 protected function eventPriceSetCreate($amount = 0, $min_fee = 0) {
85 $paramsSet['title'] = 'Two Options';
86 $paramsSet['name'] = CRM_Utils_String
::titleToVar('Two Options');
87 $paramsSet['is_active'] = FALSE;
88 $paramsSet['extends'] = 1;
90 $priceSet = CRM_Price_BAO_PriceSet
::create($paramsSet);
93 'label' => 'Price Field',
94 'name' => CRM_Utils_String
::titleToVar('Two Options'),
95 'html_type' => 'Radio',
96 //'price' => $feeTotal,
97 'option_label' => array('1' => 'Expensive Room', '2' => "Cheap Room", '3' => 'Very Expensive'),
98 'option_value' => array('1' => 'E', '2' => 'C', '3' => 'V'),
99 'option_name' => array('1' => 'Expensive', '2' => "Cheap", "3" => "Very Expensive"),
100 'option_weight' => array('1' => 1, '2' => 2, '3' => 3),
101 'option_amount' => array('1' => $this->_expensiveFee
, '2' => $this->_cheapFee
, '3' => $this->_veryExpensive
),
102 'is_display_amounts' => 1,
104 'options_per_line' => 1,
105 'is_active' => array('1' => 1),
106 'price_set_id' => $priceSet->id
,
108 'financial_type_id' => $this->getFinancialTypeId('Event Fee'),
110 $field = CRM_Price_BAO_PriceField
::create($paramsField);
111 $this->priceSetFieldID
= $field->id
;
112 return $priceSet->id
;
116 * Get the total for the invoice.
118 * @param int $contributionId
121 private function contributionInvoice($contributionId) {
124 SELECT SUM(line_total) total
125 FROM civicrm_line_item
126 WHERE entity_table = 'civicrm_participant'
127 AND entity_id = {$contributionId}";
128 $dao = CRM_Core_DAO
::executeQuery($query);
130 $this->assertTrue($dao->fetch(), "Succeeded retrieving invoicetotal");
135 * Get the total income from the participant record.
137 * @param int $participantId
141 private function totalIncome($participantId) {
143 // @todo use INNER JOINS, this is not our style.
145 SELECT SUM(et.amount) total
146 FROM civicrm_entity_financial_trxn et
147 , civicrm_financial_item fi
148 , civicrm_line_item li
149 WHERE et.entity_table='civicrm_financial_item'
150 AND fi.id = et.entity_id
151 AND fi.entity_table='civicrm_line_item'
152 AND fi.entity_id = li.id
153 AND li.entity_table = 'civicrm_participant'
154 AND li.entity_id = ${participantId}
156 $dao = CRM_Core_DAO
::executeQuery($query);
158 $this->assertTrue($dao->fetch(), "Succeeded retrieving total Income");
163 * Check the relevant entity balances.
165 * @param float $amount
167 private function balanceCheck($amount) {
168 $this->assertEquals($this->contributionInvoice($this->contributionID
), $amount, "Invoice must a total of $amount");
169 $this->assertEquals($this->totalIncome($this->participantID
), $amount, "The recorded income must be $amount ");
170 $this->assertEquals($this->totalIncome($this->contributionID
), $amount, "The accumulated assets must be $amount ");
174 * Prepare records for editing.
176 public function registerParticipantAndPay() {
181 'event_id' => $this->_eventId
,
182 'register_date' => date('Y-m-d') . " 00:00:00",
185 'source' => 'Event_' . $this->_eventId
,
186 'contact_id' => $this->_contactId
,
187 //'fee_level' => CRM_Core_DAO::VALUE_SEPARATOR.'Expensive Room'.CRM_Core_DAO::VALUE_SEPARATOR,
189 $participant = $this->callAPISuccess('Participant', 'create', $params);
190 $this->_participantId
= $participant['id'];
192 $actualPaidAmt = $this->_expensiveFee
;
194 $contributionParams = array(
195 'total_amount' => $actualPaidAmt,
196 'source' => 'Testset with information',
198 'non_deductible_amount' => 'null',
199 'receipt_date' => date('Y-m-d') . " 00:00:00",
200 'contact_id' => $this->_contactId
,
201 'financial_type_id' => 4,
202 'payment_instrument_id' => 4,
203 'contribution_status_id' => 1,
204 'receive_date' => date('Y-m-d') . " 00:00:00",
206 'partial_payment_total' => $this->_expensiveFee
,
207 'partial_amount_to_pay' => $actualPaidAmt,
210 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams);
211 $this->_contributionId
= $contribution->id
;
213 $this->callAPISuccess('participant_payment', 'create', array(
214 'participant_id' => $this->_participantId
,
215 'contribution_id' => $this->_contributionId
,
218 $PSparams['price_1'] = 1; // 1 is the option of the expensive room
219 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_participantId
, 'participant');
220 CRM_Price_BAO_PriceSet
::processAmount($this->_feeBlock
, $PSparams, $lineItem);
221 $lineItemVal[$this->_priceSetID
] = $lineItem;
222 CRM_Price_BAO_LineItem
::processPriceSet($participant['id'], $lineItemVal, $contribution, 'civicrm_participant');
224 $this->contributionID
= $this->callAPISuccessGetValue('Contribution', array('return' => 'id'));
225 $this->participantID
= $this->callAPISuccessGetValue('Participant', array('return' => 'id'));
226 $this->balanceCheck($this->_expensiveFee
);
229 public function testCRM19273() {
230 $PSparams['price_1'] = 2;
231 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->participantID
, 'participant');
232 CRM_Price_BAO_LineItem
::changeFeeSelections($PSparams, $this->participantID
, 'participant', $this->_contributionId
, $this->_feeBlock
, $lineItem, $this->_expensiveFee
);
233 $this->balanceCheck($this->_cheapFee
);
235 $PSparams['price_1'] = 1;
236 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->participantID
, 'participant');
237 CRM_Price_BAO_LineItem
::changeFeeSelections($PSparams, $this->participantID
, 'participant', $this->_contributionId
, $this->_feeBlock
, $lineItem, $this->_expensiveFee
);
238 $this->balanceCheck($this->_expensiveFee
);
240 $PSparams['price_1'] = 3;
241 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->participantID
, 'participant');
243 CRM_Price_BAO_LineItem
::changeFeeSelections($PSparams, $this->participantID
, 'participant', $this->_contributionId
, $this->_feeBlock
, $lineItem, $this->_expensiveFee
);
244 $this->balanceCheck($this->_veryExpensive
);
249 * Test that proper financial items are recorded for cancelled line items
251 public function testCRM20611() {
252 $PSparams['price_1'] = 1;
253 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->participantID
, 'participant');
254 CRM_Event_BAO_Participant
::changeFeeSelections($PSparams, $this->participantID
, $this->_contributionId
, $this->_feeBlock
, $lineItem, $this->_expensiveFee
, $this->_priceSetID
);
255 $this->balanceCheck($this->_expensiveFee
);
257 $PSparams['price_1'] = 2;
258 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->participantID
, 'participant');
259 CRM_Event_BAO_Participant
::changeFeeSelections($PSparams, $this->participantID
, $this->_contributionId
, $this->_feeBlock
, $lineItem, $this->_expensiveFee
, $this->_priceSetID
);
260 $this->balanceCheck($this->_cheapFee
);
262 //Complete the refund payment.
263 $submittedValues = array(
264 'total_amount' => 120,
265 'payment_instrument_id' => 3,
267 CRM_Contribute_BAO_Contribution
::recordAdditionalPayment($this->_contributionId
, $submittedValues, 'refund', $this->participantID
);
269 // retrieve the cancelled line-item information
270 $cancelledLineItem = $this->callAPISuccessGetSingle('LineItem', array(
271 'entity_table' => 'civicrm_participant',
272 'entity_id' => $this->participantID
,
275 // retrieve the related financial lin-items
276 $financialItems = $this->callAPISuccess('FinancialItem', 'Get', array(
277 'entity_id' => $cancelledLineItem['id'],
278 'entity_table' => 'civicrm_line_item',
280 $this->assertEquals($financialItems['count'], 2, 'Financial Items for Cancelled fee is not proper');
282 $contributionCompletedStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
283 $expectedAmount = 100.00;
284 foreach ($financialItems['values'] as $id => $financialItem) {
285 $this->assertEquals($expectedAmount, $financialItem['amount']);
286 $this->assertNotEmpty($financialItem['financial_account_id']);
287 $this->assertEquals($contributionCompletedStatusID, $financialItem['status_id']);
288 $expectedAmount = -$expectedAmount;