tests/phpunit/api/v3/ParticipantPaymentTest.php

   1 <?php
   2 /**
   3  * +--------------------------------------------------------------------+
   4  * | CiviCRM version 4.7                                                |
   5  * +--------------------------------------------------------------------+
   6  * | Copyright CiviCRM LLC (c) 2004-2015                                |
   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 /**
  29  *  Test APIv3 civicrm_participant_* functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Event
  33  */
  34 class api_v3_ParticipantPaymentTest extends CiviUnitTestCase {
  35
  36   protected $_apiversion = 3;
  37   protected $_contactID;
  38   protected $_createdParticipants;
  39   protected $_participantID;
  40   protected $_eventID;
  41   protected $_participantPaymentID;
  42   protected $_financialTypeId;
  43
  44   /**
  45    * Set up for tests.
  46    */
  47   public function setUp() {
  48     parent::setUp();
  49     $this->useTransaction(TRUE);
  50     $event = $this->eventCreate(NULL);
  51     $this->_eventID = $event['id'];
  52     $this->_contactID = $this->individualCreate();
  53     $this->_createdParticipants = array();
  54     $this->_individualId = $this->individualCreate();
  55     $this->_financialTypeId = 1;
  56
  57     $this->_participantID = $this->participantCreate(array(
  58         'contactID' => $this->_contactID,
  59         'eventID' => $this->_eventID,
  60       ));
  61     $this->_contactID2 = $this->individualCreate();
  62     $this->_participantID2 = $this->participantCreate(array(
  63         'contactID' => $this->_contactID2,
  64         'eventID' => $this->_eventID,
  65       ));
  66     $this->_participantID3 = $this->participantCreate(array(
  67         'contactID' => $this->_contactID2,
  68         'eventID' => $this->_eventID,
  69       ));
  70
  71     $this->_contactID3 = $this->individualCreate();
  72     $this->_participantID4 = $this->participantCreate(array(
  73         'contactID' => $this->_contactID3,
  74         'eventID' => $this->_eventID,
  75       ));
  76   }
  77
  78   /**
  79    * Test civicrm_participant_payment_create with wrong params type.
  80    */
  81   public function testPaymentCreateWrongParamsType() {
  82     $params = 'a string';
  83     $this->callAPIFailure('participant_payment', 'create', $params);
  84   }
  85
  86   /**
  87    * Test civicrm_participant_payment_create with empty params.
  88    */
  89   public function testPaymentCreateEmptyParams() {
  90     $params = array();
  91     $this->callAPIFailure('participant_payment', 'create', $params);
  92   }
  93
  94   /**
  95    * Check without contribution_id.
  96    */
  97   public function testPaymentCreateMissingContributionId() {
  98     //Without Payment EntityID
  99     $params = array(
 100       'participant_id' => $this->_participantID,
 101     );
 102     $this->callAPIFailure('participant_payment', 'create', $params);
 103   }
 104
 105   /**
 106    * Check with valid array.
 107    */
 108   public function testPaymentCreate() {
 109     //Create Contribution & get contribution ID
 110     $contributionID = $this->contributionCreate(array('contact_id' => $this->_contactID));
 111
 112     //Create Participant Payment record With Values
 113     $params = array(
 114       'participant_id' => $this->_participantID,
 115       'contribution_id' => $contributionID,
 116     );
 117
 118     $result = $this->callAPIAndDocument('participant_payment', 'create', $params, __FUNCTION__, __FILE__);
 119     $this->assertTrue(array_key_exists('id', $result));
 120
 121     //delete created contribution
 122     $this->contributionDelete($contributionID);
 123   }
 124
 125
 126   ///////////////// civicrm_participant_payment_create methods
 127
 128   /**
 129    * Test civicrm_participant payment create with wrong params type.
 130    */
 131   public function testPaymentUpdateWrongParamsType() {
 132     $params = 'a string';
 133     $result = $this->callAPIFailure('participant_payment', 'create', $params);
 134     $this->assertEquals('Input variable `params` is not an array', $result['error_message']);
 135   }
 136
 137   /**
 138    * Check with empty array.
 139    */
 140   public function testPaymentUpdateEmpty() {
 141     $this->callAPIFailure('participant_payment', 'create', array());
 142   }
 143
 144   /**
 145    * Check with missing participant_id.
 146    */
 147   public function testPaymentUpdateMissingParticipantId() {
 148     $params = array(
 149       'contribution_id' => '3',
 150     );
 151     $this->callAPIFailure('participant_payment', 'create', $params);
 152   }
 153
 154   /**
 155    * Check with missing contribution_id.
 156    */
 157   public function testPaymentUpdateMissingContributionId() {
 158     $params = array(
 159       'participant_id' => $this->_participantID,
 160     );
 161     $participantPayment = $this->callAPIFailure('participant_payment', 'create', $params);
 162   }
 163
 164   /**
 165    * Check financial records for offline Participants.
 166    */
 167   public function testPaymentOffline() {
 168
 169     // create contribution w/o fee
 170     $contributionID = $this->contributionCreate(array(
 171       'contact_id' => $this->_contactID,
 172       'financial_type_id' => $this->_financialTypeId,
 173       'payment_instrument_id' => 4,
 174       'fee_amount' => 0,
 175       'net_amount' => 100,
 176     ));
 177
 178     $this->_participantPaymentID = $this->participantPaymentCreate($this->_participantID, $contributionID);
 179     $params = array(
 180       'id' => $this->_participantPaymentID,
 181       'participant_id' => $this->_participantID,
 182       'contribution_id' => $contributionID,
 183     );
 184
 185     // Update Payment
 186     $participantPayment = $this->callAPISuccess('participant_payment', 'create', $params);
 187     $this->assertEquals($participantPayment['id'], $this->_participantPaymentID);
 188     $this->assertTrue(array_key_exists('id', $participantPayment));
 189     // check Financial records
 190     $this->_checkFinancialRecords($params, 'offline');
 191     $params = array(
 192       'id' => $this->_participantPaymentID,
 193     );
 194     $deletePayment = $this->callAPISuccess('participant_payment', 'delete', $params);
 195   }
 196
 197   /**
 198    * Check financial records for online Participant.
 199    */
 200   public function testPaymentOnline() {
 201
 202     $pageParams['processor_id'] = $this->processorCreate();
 203     $contributionPage = $this->contributionPageCreate($pageParams);
 204     $contributionParams = array(
 205       'contact_id' => $this->_contactID,
 206       'contribution_page_id' => $contributionPage['id'],
 207       'payment_processor' => $pageParams['processor_id'],
 208       'financial_type_id' => 1,
 209     );
 210     $contributionID = $this->contributionCreate($contributionParams);
 211
 212     $this->_participantPaymentID = $this->participantPaymentCreate($this->_participantID, $contributionID);
 213     $params = array(
 214       'id' => $this->_participantPaymentID,
 215       'participant_id' => $this->_participantID,
 216       'contribution_id' => $contributionID,
 217     );
 218
 219     // Update Payment
 220     $participantPayment = $this->callAPISuccess('participant_payment', 'create', $params);
 221     $this->assertEquals($participantPayment['id'], $this->_participantPaymentID);
 222     $this->assertTrue(array_key_exists('id', $participantPayment));
 223     // check Financial records
 224     $this->_checkFinancialRecords($params, 'online');
 225     $params = array(
 226       'id' => $this->_participantPaymentID,
 227     );
 228     $this->callAPISuccess('participant_payment', 'delete', $params);
 229   }
 230
 231   /**
 232    * Check financial records for online Participant pay later scenario.
 233    */
 234   public function testPaymentPayLaterOnline() {
 235     $pageParams['processor_id'] = $this->processorCreate();
 236     $pageParams['is_pay_later'] = 1;
 237     $contributionPage = $this->contributionPageCreate($pageParams);
 238     $contributionParams = array(
 239       'contact_id' => $this->_contactID,
 240       'contribution_page_id' => $contributionPage['id'],
 241       'contribution_status_id' => 2,
 242       'is_pay_later' => 1,
 243       'financial_type_id' => 1,
 244     );
 245     $contributionID = $this->contributionCreate($contributionParams);
 246
 247     $this->_participantPaymentID = $this->participantPaymentCreate($this->_participantID, $contributionID);
 248     $params = array(
 249       'id' => $this->_participantPaymentID,
 250       'participant_id' => $this->_participantID,
 251       'contribution_id' => $contributionID,
 252     );
 253
 254     // Update Payment
 255     $participantPayment = $this->callAPISuccess('participant_payment', 'create', $params);
 256     // check Financial Records
 257     $this->_checkFinancialRecords($params, 'payLater');
 258     $this->assertEquals($participantPayment['id'], $this->_participantPaymentID);
 259     $this->assertTrue(array_key_exists('id', $participantPayment));
 260     $params = array(
 261       'id' => $this->_participantPaymentID,
 262     );
 263     $this->callAPISuccess('participant_payment', 'delete', $params);
 264   }
 265
 266
 267   /**
 268    * Test civicrm_participant_payment_delete with wrong params type.
 269    */
 270   public function testPaymentDeleteWrongParamsType() {
 271     $params = 'a string';
 272     $this->callAPIFailure('participant_payment', 'delete', $params);
 273   }
 274
 275   /**
 276    * Check with empty array.
 277    */
 278   public function testPaymentDeleteWithEmptyParams() {
 279     $params = array();
 280     $deletePayment = $this->callAPIFailure('participant_payment', 'delete', $params);
 281     $this->assertEquals('Mandatory key(s) missing from params array: id', $deletePayment['error_message']);
 282   }
 283
 284   /**
 285    * Check with wrong id.
 286    */
 287   public function testPaymentDeleteWithWrongID() {
 288     $params = array(
 289       'id' => 0,
 290     );
 291     $deletePayment = $this->callAPIFailure('participant_payment', 'delete', $params);
 292     $this->assertEquals($deletePayment['error_message'], 'Error while deleting participantPayment');
 293   }
 294
 295   /**
 296    * Check with valid array.
 297    */
 298   public function testPaymentDelete() {
 299     $contributionID = $this->contributionCreate(array(
 300       'contact_id' => $this->_contactID,
 301     ));
 302
 303     $this->_participantPaymentID = $this->participantPaymentCreate($this->_participantID, $contributionID);
 304
 305     $params = array(
 306       'id' => $this->_participantPaymentID,
 307     );
 308     $this->callAPIAndDocument('participant_payment', 'delete', $params, __FUNCTION__, __FILE__);
 309   }
 310
 311   /**
 312    * Test civicrm_participantPayment_get - success expected.
 313    */
 314   public function testGet() {
 315     $contributionID = $this->contributionCreate(array('contact_id' => $this->_contactID3));
 316     $this->participantPaymentCreate($this->_participantID4, $contributionID);
 317
 318     //Create Participant Payment record With Values
 319     $params = array(
 320       'participant_id' => $this->_participantID4,
 321       'contribution_id' => $contributionID,
 322     );
 323
 324     $result = $this->callAPIAndDocument('participant_payment', 'get', $params, __FUNCTION__, __FILE__);
 325     $this->assertEquals($result['values'][$result['id']]['participant_id'], $this->_participantID4, 'Check Participant Id');
 326     $this->assertEquals($result['values'][$result['id']]['contribution_id'], $contributionID, 'Check Contribution Id');
 327   }
 328
 329   /**
 330    * @param array $params
 331    * @param $context
 332    */
 333   public function _checkFinancialRecords($params, $context) {
 334     $entityParams = array(
 335       'entity_id' => $params['id'],
 336       'entity_table' => 'civicrm_contribution',
 337     );
 338     $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
 339     $trxnParams = array(
 340       'id' => $trxn['financial_trxn_id'],
 341     );
 342
 343     switch ($context) {
 344       case 'online':
 345         $compareParams = array(
 346           'to_financial_account_id' => 12,
 347           'total_amount' => 100,
 348           'status_id' => 1,
 349         );
 350         break;
 351
 352       case 'offline':
 353         $compareParams = array(
 354           'to_financial_account_id' => 6,
 355           'total_amount' => 100,
 356           'status_id' => 1,
 357         );
 358         break;
 359
 360       case 'payLater':
 361         $compareParams = array(
 362           'to_financial_account_id' => 7,
 363           'total_amount' => 100,
 364           'status_id' => 2,
 365         );
 366         break;
 367     }
 368
 369     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
 370     $entityParams = array(
 371       'financial_trxn_id' => $trxn['financial_trxn_id'],
 372       'entity_table' => 'civicrm_financial_item',
 373     );
 374     $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
 375     $fitemParams = array(
 376       'id' => $entityTrxn['entity_id'],
 377     );
 378     if ($context == 'offline' || $context == 'online') {
 379       $compareParams = array(
 380         'amount' => 100,
 381         'status_id' => 1,
 382         'financial_account_id' => 1,
 383       );
 384     }
 385     elseif ($context == 'payLater') {
 386       $compareParams = array(
 387         'amount' => 100,
 388         'status_id' => 3,
 389         'financial_account_id' => 1,
 390       );
 391     }
 392     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
 393   }
 394
 395 }