3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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 +--------------------------------------------------------------------+
29 * Test class for Batch API - civicrm_participant_*
31 * @package CiviCRM_APIv3
33 require_once 'CRM/Utils/DeprecatedUtils.php';
37 * Class api_v3_ParticipantTest
40 class api_v3_ParticipantTest
extends CiviUnitTestCase
{
42 protected $_apiversion;
44 protected $_contactID;
45 protected $_contactID2;
46 protected $_createdParticipants;
47 protected $_participantID;
49 protected $_individualId;
52 public function setUp() {
53 $this->_apiversion
= 3;
55 $this->_entity
= 'participant';
56 $event = $this->eventCreate(NULL);
57 $this->_eventID
= $event['id'];
59 $this->_contactID
= $this->individualCreate();
61 $this->_createdParticipants
= array();
62 $this->_individualId
= $this->individualCreate();
64 $this->_participantID
= $this->participantCreate(array(
65 'contact_id' => $this->_contactID
,
66 'event_id' => $this->_eventID
,
68 $this->_contactID2
= $this->individualCreate();
69 $this->_participantID2
= $this->participantCreate(array(
70 'contact_id' => $this->_contactID2
,
71 'event_id' => $this->_eventID
,
72 'registered_by_id' => $this->_participantID
,
74 $this->_participantID3
= $this->participantCreate(array(
75 'contact_id' => $this->_contactID2
,
76 'event_id' => $this->_eventID
,
78 $this->_params
= array(
79 'contact_id' => $this->_contactID
,
80 'event_id' => $this->_eventID
,
83 // to ensure it matches later on
84 'register_date' => '2007-07-21 00:00:00',
85 'source' => 'Online Event Registration: API Testing',
89 public function tearDown() {
90 $this->eventDelete($this->_eventID
);
91 $tablesToTruncate = array(
92 'civicrm_custom_group',
93 'civicrm_custom_field',
95 'civicrm_participant',
97 // true tells quickCleanup to drop any tables that might have been created in the test
98 $this->quickCleanup($tablesToTruncate, TRUE);
102 * Check with complete array + custom field
103 * Note that the test is written on purpose without any
104 * variables specific to participant so it can be replicated into other entities
105 * and / or moved to the automated test suite
107 public function testCreateWithCustom() {
108 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
110 $params = $this->_params
;
111 $params['custom_' . $ids['custom_field_id']] = "custom string";
113 $result = $this->callAPIAndDocument($this->_entity
, 'create', $params, __FUNCTION__
, __FILE__
);
115 $this->assertEquals($result['id'], $result['values'][$result['id']]['id']);
117 $check = $this->callAPISuccess($this->_entity
, 'get', array('id' => $result['id']));
118 $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__
);
120 $this->customFieldDelete($ids['custom_field_id']);
121 $this->customGroupDelete($ids['custom_group_id']);
125 ///////////////// civicrm_participant_get methods
128 * Check with wrong params type.
130 public function testGetWrongParamsType() {
131 $params = 'a string';
132 $result = $this->callAPIFailure('participant', 'get', $params);
136 * Test civicrm_participant_get with empty params.
138 public function testGetEmptyParams() {
139 $this->callAPISuccess('participant', 'get', array());
143 * Check with participant_id.
145 public function testGetParticipantIdOnly() {
147 'participant_id' => $this->_participantID
,
151 'participant_register_date',
152 'participant_source',
155 $result = $this->callAPISuccess('participant', 'get', $params);
156 $this->assertAPISuccess($result, " in line " . __LINE__
);
157 $this->assertEquals($result['values'][$this->_participantID
]['event_id'], $this->_eventID
, "in line " . __LINE__
);
158 $this->assertEquals($result['values'][$this->_participantID
]['participant_register_date'], '2007-02-19 00:00:00', "in line " . __LINE__
);
159 $this->assertEquals($result['values'][$this->_participantID
]['participant_source'], 'Wimbeldon', "in line " . __LINE__
);
161 'id' => $this->_participantID
,
162 'return' => 'id,participant_register_date,event_id',
165 $result = $this->callAPISuccess('participant', 'get', $params);
166 $this->assertEquals($result['values'][$this->_participantID
]['event_id'], $this->_eventID
);
167 $this->assertEquals($result['values'][$this->_participantID
]['participant_register_date'], '2007-02-19 00:00:00');
172 * Check with params id.
174 public function testGetParamsAsIdOnly() {
176 'id' => $this->_participantID
,
178 $result = $this->callAPIAndDocument('participant', 'get', $params, __FUNCTION__
, __FILE__
);
179 $this->assertEquals($result['values'][$this->_participantID
]['event_id'], $this->_eventID
);
180 $this->assertEquals($result['values'][$this->_participantID
]['participant_register_date'], '2007-02-19 00:00:00');
181 $this->assertEquals($result['values'][$this->_participantID
]['participant_source'], 'Wimbeldon');
182 $this->assertEquals($result['id'], $result['values'][$this->_participantID
]['id']);
186 * Check with params id.
188 public function testGetNestedEventGet() {
189 //create a second event & add participant to it.
190 $event = $this->eventCreate(NULL);
191 $this->callAPISuccess('participant', 'create', array(
192 'event_id' => $event['id'],
193 'contact_id' => $this->_contactID
,
196 $description = "Demonstrates use of nested get to fetch event data with participant records.";
197 $subfile = "NestedEventGet";
199 'id' => $this->_participantID
,
200 'api.event.get' => 1,
202 $result = $this->callAPIAndDocument('participant', 'get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
203 $this->assertEquals($result['values'][$this->_participantID
]['event_id'], $this->_eventID
);
204 $this->assertEquals($result['values'][$this->_participantID
]['participant_register_date'], '2007-02-19 00:00:00');
205 $this->assertEquals($result['values'][$this->_participantID
]['participant_source'], 'Wimbeldon');
206 $this->assertEquals($this->_eventID
, $result['values'][$this->_participantID
]['api.event.get']['id']);
210 * Check Participant Get respects return properties.
212 public function testGetWithReturnProperties() {
214 'contact_id' => $this->_contactID
,
215 'return.status_id' => 1,
216 'return.participant_status_id' => 1,
217 'options' => array('limit' => 1),
219 $result = $this->callAPISuccess('participant', 'get', $params);
220 $this->assertArrayHasKey('participant_status_id', $result['values'][$result['id']]);
224 * Check with contact_id.
226 public function testGetContactIdOnly() {
228 'contact_id' => $this->_contactID
,
230 $participant = $this->callAPISuccess('participant', 'get', $params);
232 $this->assertEquals($this->_participantID
, $participant['id'],
233 "In line " . __LINE__
235 $this->assertEquals($this->_eventID
, $participant['values'][$participant['id']]['event_id'],
236 "In line " . __LINE__
238 $this->assertEquals('2007-02-19 00:00:00', $participant['values'][$participant['id']]['participant_register_date'],
239 "In line " . __LINE__
241 $this->assertEquals('Wimbeldon', $participant['values'][$participant['id']]['participant_source'],
242 "In line " . __LINE__
244 $this->assertEquals($participant['id'], $participant['values'][$participant['id']]['id'],
245 "In line " . __LINE__
250 * Check with event_id.
253 public function testGetMultiMatchReturnFirst() {
255 'event_id' => $this->_eventID
,
259 $participant = $this->callAPISuccess('participant', 'get', $params);
260 $this->assertNotNull($participant['id']);
264 * Check with event_id.
265 * in v3 this should return all participants
267 public function testGetMultiMatchNoReturnFirst() {
269 'event_id' => $this->_eventID
,
271 $participant = $this->callAPISuccess('participant', 'get', $params);
272 $this->assertNotNull($participant['count'], 3);
275 ///////////////// civicrm_participant_get methods
278 * Test civicrm_participant_get with empty params.
279 * In this case all the participant records are returned.
281 public function testSearchEmptyParams() {
282 $result = $this->callAPISuccess('participant', 'get', array());
283 // expecting 3 participant records
284 $this->assertEquals($result['count'], 3);
288 * Check with participant_id.
290 public function testSearchParticipantIdOnly() {
292 'participant_id' => $this->_participantID
,
294 $participant = $this->callAPISuccess('participant', 'get', $params);
295 $this->assertEquals($participant['values'][$this->_participantID
]['event_id'], $this->_eventID
);
296 $this->assertEquals($participant['values'][$this->_participantID
]['participant_register_date'], '2007-02-19 00:00:00');
297 $this->assertEquals($participant['values'][$this->_participantID
]['participant_source'], 'Wimbeldon');
301 * Check with contact_id.
303 public function testSearchContactIdOnly() {
304 // Should get 2 participant records for this contact.
306 'contact_id' => $this->_contactID2
,
308 $participant = $this->callAPISuccess('participant', 'get', $params);
310 $this->assertEquals($participant['count'], 2);
314 * Check with event_id.
316 public function testSearchByEvent() {
317 // Should get >= 3 participant records for this event. Also testing that last_name and event_title are returned.
319 'event_id' => $this->_eventID
,
320 'return.last_name' => 1,
321 'return.event_title' => 1,
323 $participant = $this->callAPISuccess('participant', 'get', $params);
324 if ($participant['count'] < 3) {
325 $this->fail("Event search returned less than expected miniumum of 3 records.");
328 $this->assertEquals($participant['values'][$this->_participantID
]['last_name'], 'Anderson');
329 $this->assertEquals($participant['values'][$this->_participantID
]['event_title'], 'Annual CiviCRM meet');
333 * Check with event_id.
336 public function testSearchByEventWithLimit() {
337 // Should 2 participant records since we're passing rowCount = 2.
339 'event_id' => $this->_eventID
,
342 $participant = $this->callAPISuccess('participant', 'get', $params);
344 $this->assertEquals($participant['count'], 2);
348 * Test search by lead booker (registered by ID)
350 public function testSearchByRegisteredById() {
352 'registered_by_id' => $this->_participantID
,
354 $participant = $this->callAPISuccess('participant', 'get', $params);
356 $this->assertEquals($participant['count'], 1);
357 $this->assertEquals($participant['id'], $this->_participantID2
);
360 ///////////////// civicrm_participant_create methods
363 * Test civicrm_participant_create with empty params.
365 public function testCreateEmptyParams() {
367 $result = $this->callAPIFailure('participant', 'create', $params);
371 * Check with event_id.
373 public function testCreateMissingContactID() {
375 'event_id' => $this->_eventID
,
377 $participant = $this->callAPIFailure('participant', 'create', $params);
381 * Check with contact_id.
384 public function testCreateMissingEventID() {
386 'contact_id' => $this->_contactID
,
388 $participant = $this->callAPIFailure('participant', 'create', $params);
392 * Check with contact_id & event_id
394 public function testCreateEventIdOnly() {
396 'contact_id' => $this->_contactID
,
397 'event_id' => $this->_eventID
,
399 $participant = $this->callAPISuccess('participant', 'create', $params);
400 $this->getAndCheck($params, $participant['id'], 'participant');
404 * Check with complete array.
406 public function testCreateAllParams() {
407 $params = $this->_params
;
409 $participant = $this->callAPISuccess('participant', 'create', $params);
410 $this->_participantID
= $participant['id'];
411 // assertDBState compares expected values in $match to actual values in the DB
412 $this->assertDBState('CRM_Event_DAO_Participant', $participant['id'], $params);
416 * Test to check if receive date is being changed per CRM-9763
418 public function testCreateUpdateReceiveDate() {
419 $participant = $this->callAPISuccess('participant', 'create', $this->_params
);
421 'id' => $participant['id'],
424 $this->callAPISuccess('participant', 'create', $update);
425 $this->getAndCheck(array_merge($this->_params
, $update), $participant['id'], 'participant');
429 * Test to check if participant fee level is being changed per CRM-9781
431 public function testCreateUpdateParticipantFeeLevel() {
432 $myParams = $this->_params +
array('participant_fee_level' => CRM_Core_DAO
::VALUE_SEPARATOR
. "fee" . CRM_Core_DAO
::VALUE_SEPARATOR
);
433 $participant = $this->callAPISuccess('participant', 'create', $myParams);
435 'id' => $participant['id'],
438 $update = $this->callAPISuccess('participant', 'create', $update);
440 $this->assertEquals($participant['values'][$participant['id']]['fee_level'],
441 $update['values'][$participant['id']]['fee_level']
444 $this->callAPISuccess('participant', 'delete', array('id' => $participant['id']));
448 * Test the line items for participant fee with multiple price field values.
450 public function testCreateParticipantLineItems() {
451 // Create a price set for this event.
453 $priceset = $this->callAPISuccess('PriceSet', 'create', array(
454 'name' => 'my_price_set',
455 'title' => 'My Price Set',
458 'financial_type_id' => 4,
459 // 'entity' => array('civicrm_event' => array($this->_eventID)),
462 // Add the price set to the event with another API call.
463 // I tried to do this at once, but it did not work.
465 $priceset = $this->callAPISuccess('PriceSet', 'create', array(
466 'entity_table' => 'civicrm_event',
467 'entity_id' => $this->_eventID
,
468 'id' => $priceset['id'],
471 $pricefield = $this->callAPISuccess('PriceField', 'create', array(
472 'price_set_id' => $priceset['id'],
473 'name' => 'mypricefield',
474 'label' => 'My Price Field',
475 'html_type' => 'Text',
477 'is_display_amounts' => 1,
481 $pfv1 = $this->callAPISuccess('PriceFieldValue', 'create', array(
482 'price_field_id' => $pricefield['id'],
483 'name' => 'pricefieldvalue1',
484 'label' => 'pricefieldvalue1',
487 'financial_type_id' => 4,
490 $pfv2 = $this->callAPISuccess('PriceFieldValue', 'create', array(
491 'price_field_id' => $pricefield['id'],
492 'name' => 'pricefieldvalue2',
493 'label' => 'pricefieldvalue2',
496 'financial_type_id' => 4,
499 // pay 2 times price field value 1, and 2 times price field value 2.
500 $myParams = $this->_params +
array('participant_fee_level' => CRM_Core_DAO
::VALUE_SEPARATOR
. "pricefieldvalue1 - 2" . CRM_Core_DAO
::VALUE_SEPARATOR
. "pricefieldvalue2 - 2" . CRM_Core_DAO
::VALUE_SEPARATOR
);
501 $participant = $this->callAPISuccess('participant', 'create', $myParams);
503 // expect 2 line items.
504 $lineItems = $this->callAPISuccess('LineItem', 'get', array(
505 'entity_id' => $participant['id'],
506 'entity_table' => 'civicrm_participant',
509 $this->assertEquals(2, $lineItems['count']);
511 // Check quantity, label and unit price of lines.
512 // TODO: These assertions depend on the order of the line items, which is
513 // technically incorrect.
515 $lineItem = array_pop($lineItems['values']);
516 $this->assertEquals(2, $lineItem['qty']);
517 $this->assertEquals(5, $lineItem['unit_price']);
518 $this->assertEquals('pricefieldvalue2', $lineItem['label']);
520 $lineItem = array_pop($lineItems['values']);
521 $this->assertEquals(2, $lineItem['qty']);
522 $this->assertEquals(20, $lineItem['unit_price']);
523 $this->assertEquals('pricefieldvalue1', $lineItem['label']);
526 $this->callAPISuccess('participant', 'delete', array('id' => $participant['id']));
528 // TODO: I think the price set should be removed, but I don't know how
529 // to decouple it properly from the event. For the moment, I'll just comment
530 // out the lines below.
533 $this->callAPISuccess('PriceFieldValue', 'delete', array('id' => $pfv1['id']));
534 $this->callAPISuccess('PriceFieldValue', 'delete', array('id' => $pfv2['id']));
535 $this->callAPISuccess('PriceField', 'delete', array('id' => $pricefield['id']));
536 $this->callAPISuccess('PriceSet', 'delete', array('id' => $priceset['id']));
541 * Check with complete array.
543 public function testUpdate() {
544 $participantId = $this->participantCreate(array(
545 'contactID' => $this->_individualId
,
546 'eventID' => $this->_eventID
,
549 'id' => $participantId,
550 'contact_id' => $this->_individualId
,
551 'event_id' => $this->_eventID
,
554 'register_date' => '2006-01-21',
555 'source' => 'US Open',
557 $participant = $this->callAPISuccess('participant', 'create', $params);
558 $this->getAndCheck($params, $participant['id'], 'participant');
559 $result = $this->participantDelete($params['id']);
563 * Test to check if participant fee level is being changed per CRM-9781
564 * Try again without a custom separater to check that one isn't added
565 * (get & check won't accept an array)
567 public function testUpdateCreateParticipantFeeLevelNoSeparator() {
569 $myParams = $this->_params +
array('participant_fee_level' => "fee");
570 $participant = $this->callAPISuccess('participant', 'create', $myParams);
571 $this->assertAPISuccess($participant);
573 'id' => $participant['id'],
576 $this->callAPISuccess('participant', 'create', $update);
577 $this->assertEquals($participant['values'][$participant['id']]['fee_level'],
578 $myParams['participant_fee_level']
580 $this->getAndCheck($update, $participant['id'], 'participant');
582 ///////////////// civicrm_participant_update methods
585 * Test civicrm_participant_update with wrong params type.
587 public function testUpdateWrongParamsType() {
588 $params = 'a string';
589 $result = $this->callAPIFailure('participant', 'create', $params);
590 $this->assertEquals('Input variable `params` is not an array', $result['error_message']);
594 * Check with empty array.
596 public function testUpdateEmptyParams() {
598 $participant = $this->callAPIFailure('participant', 'create', $params);
599 $this->assertEquals($participant['error_message'], 'Mandatory key(s) missing from params array: event_id, contact_id');
603 * Check without event_id.
605 public function testUpdateWithoutEventId() {
606 $participantId = $this->participantCreate(array('contactID' => $this->_individualId
, 'eventID' => $this->_eventID
));
608 'contact_id' => $this->_individualId
,
611 'register_date' => '2006-01-21',
612 'source' => 'US Open',
613 'event_level' => 'Donation',
615 $participant = $this->callAPIFailure('participant', 'create', $params);
616 $this->assertEquals($participant['error_message'], 'Mandatory key(s) missing from params array: event_id');
617 // Cleanup created participant records.
618 $result = $this->participantDelete($participantId);
622 * Check with Invalid participantId.
624 public function testUpdateWithWrongParticipantId() {
629 'register_date' => '2006-01-21',
630 'source' => 'US Open',
631 'event_level' => 'Donation',
633 $participant = $this->callAPIFailure('Participant', 'update', $params);
637 * Check with Invalid ContactId.
639 public function testUpdateWithWrongContactId() {
640 $participantId = $this->participantCreate(array(
641 'contactID' => $this->_individualId
,
642 'eventID' => $this->_eventID
,
643 ), $this->_apiversion
);
645 'id' => $participantId,
646 'contact_id' => 12345,
649 'register_date' => '2006-01-21',
650 'source' => 'US Open',
651 'event_level' => 'Donation',
653 $participant = $this->callAPIFailure('participant', 'create', $params);
654 $result = $this->participantDelete($participantId);
657 ///////////////// civicrm_participant_delete methods
660 * Test civicrm_participant_delete with wrong params type.
662 public function testDeleteWrongParamsType() {
663 $params = 'a string';
664 $result = $this->callAPIFailure('participant', 'delete', $params);
668 * Test civicrm_participant_delete with empty params.
670 public function testDeleteEmptyParams() {
672 $result = $this->callAPIFailure('participant', 'delete', $params);
676 * Check with participant_id.
678 public function testParticipantDelete() {
680 'id' => $this->_participantID
,
682 $participant = $this->callAPISuccess('participant', 'delete', $params);
683 $this->assertAPISuccess($participant);
684 $this->assertDBState('CRM_Event_DAO_Participant', $this->_participantID
, NULL, TRUE);
688 * Check without participant_id.
690 * This should return an error because required param is missing..
692 public function testParticipantDeleteMissingID() {
694 'event_id' => $this->_eventID
,
696 $participant = $this->callAPIFailure('participant', 'delete', $params);
697 $this->assertNotNull($participant['error_message']);
701 * Delete with a get - a 'criteria delete'
703 public function testNestedDelete() {
704 $description = "Criteria delete by nesting a GET & a DELETE.";
705 $subfile = "NestedDelete";
706 $participants = $this->callAPISuccess('Participant', 'Get', array());
707 $this->assertEquals($participants['count'], 3);
708 $params = array('contact_id' => $this->_contactID2
, 'api.participant.delete' => 1);
709 $participants = $this->callAPIAndDocument('Participant', 'Get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
710 $check = $this->callAPISuccess('participant', 'getcount', array());
711 $this->assertEquals(1, $check, "only one participant should be left. line " . __LINE__
);
715 * Test creation of a participant with an associated contribution.
717 public function testCreateParticipantWithPayment() {
718 $description = "Single function to create contact with partipation & contribution.
719 Note that in the case of 'contribution' the 'create' is implied (api.contribution.create)";
720 $subfile = "CreateParticipantPayment";
722 'contact_type' => 'Individual',
723 'display_name' => 'dlobo',
724 'api.participant' => array(
725 'event_id' => $this->_eventID
,
728 'format.only_id' => 1,
730 'api.contribution.create' => array(
731 'financial_type_id' => 1,
732 'total_amount' => 100,
733 'format.only_id' => 1,
735 'api.participant_payment.create' => array(
736 'contribution_id' => '$value.api.contribution.create',
737 'participant_id' => '$value.api.participant',
741 $result = $this->callAPIAndDocument('contact', 'create', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
742 $this->assertEquals(1, $result['values'][$result['id']]['api.participant_payment.create']['count']);
743 $this->callAPISuccess('contact', 'delete', array('id' => $result['id']));