tests/phpunit/api/v3/MembershipPaymentTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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_membership_payment* functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Member
  33  * @group headless
  34  */
  35 class api_v3_MembershipPaymentTest extends CiviUnitTestCase {
  36   protected $_apiversion = 3;
  37   protected $_contactID;
  38   protected $_contributionTypeID;
  39   protected $_membershipTypeID;
  40   protected $_membershipStatusID;
  41   protected $_contribution = array();
  42
  43   public function setUp() {
  44     parent::setUp();
  45     $this->useTransaction(TRUE);
  46
  47     $this->_contactID = $this->organizationCreate(NULL);
  48     $this->_membershipTypeID = $this->membershipTypeCreate(array('member_of_contact_id' => $this->_contactID));
  49     $this->_membershipStatusID = $this->membershipStatusCreate('test status');
  50     $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, TRUE, 'name');
  51     $params = array(
  52       'contact_id' => $this->_contactID,
  53       'currency' => 'USD',
  54       'financial_type_id' => 1,
  55       'contribution_status_id' => 1,
  56       'contribution_page_id' => NULL,
  57       'payment_instrument_id' => 1,
  58       'source' => 'STUDENT',
  59       'receive_date' => '20080522000000',
  60       'receipt_date' => '20080522000000',
  61       'total_amount' => 200.00,
  62       'trxn_id' => '22ereerwww322323',
  63       'invoice_id' => '22ed39c9e9ee6ef6031621ce0eafe6da70',
  64       'thankyou_date' => '20080522',
  65     );
  66
  67     $this->_contribution = $this->callAPISuccess('contribution', 'create', $params);
  68   }
  69
  70   ///////////////// civicrm_membership_payment_create methods
  71
  72   /**
  73    * Test civicrm_membership_payment_create with empty params.
  74    */
  75   public function testCreateEmptyParams() {
  76     $this->callAPIFailure('membership_payment', 'create', array(), 'Mandatory key(s) missing from params array: membership_id, contribution_id');
  77   }
  78
  79   /**
  80    * Test civicrm_membership_payment_create - success expected.
  81    */
  82   public function testCreate() {
  83     $contactId = $this->individualCreate();
  84
  85     $params = array(
  86       'contact_id' => $contactId,
  87       'membership_type_id' => $this->_membershipTypeID,
  88       'join_date' => '2006-01-21',
  89       'start_date' => '2006-01-21',
  90       'end_date' => '2006-12-21',
  91       'source' => 'Payment',
  92       'is_override' => 1,
  93       'status_id' => $this->_membershipStatusID,
  94     );
  95
  96     $membership = $this->callAPISuccess('membership', 'create', $params);
  97
  98     $params = array(
  99       'contribution_id' => $this->_contribution['id'],
 100       'membership_id' => $membership['id'],
 101     );
 102     $result = $this->callAPIAndDocument('membership_payment', 'create', $params, __FUNCTION__, __FILE__);
 103     $this->assertEquals($result['values'][$result['id']]['membership_id'], $membership['id'], 'Check Membership Id in line ' . __LINE__);
 104     $this->assertEquals($result['values'][$result['id']]['contribution_id'], $this->_contribution['id'], 'Check Contribution Id in line ' . __LINE__);
 105
 106   }
 107
 108   ///////////////// civicrm_membershipPayment_get methods
 109
 110   /**
 111    * Test civicrm_membershipPayment_get with wrong params type.
 112    */
 113   public function testGetWrongParamsType() {
 114     $params = 'eeee';
 115     $GetWrongParamsType = $this->callAPIFailure('membership_payment', 'get', $params, 'Input variable `params` is not an array');
 116   }
 117
 118   /**
 119    * Test civicrm_membershipPayment_get - success expected.
 120    */
 121   public function testGet() {
 122     $contactId = $this->individualCreate();
 123     $params = array(
 124       'contact_id' => $contactId,
 125       'membership_type_id' => $this->_membershipTypeID,
 126       'source' => 'Payment',
 127       'is_override' => 1,
 128       'status_id' => $this->_membershipStatusID,
 129     );
 130
 131     $membership = $this->callAPISuccess('membership', 'create', $params);
 132
 133     $params = array(
 134       'contribution_id' => $this->_contribution['id'],
 135       'membership_id' => $membership['id'],
 136     );
 137     $this->callAPISuccess('membership_payment', 'create', $params);
 138
 139     $result = $this->callAPIAndDocument('membership_payment', 'get', $params, __FUNCTION__, __FILE__);
 140     $this->assertEquals($result['values'][$result['id']]['membership_id'], $params['membership_id'], 'Check Membership Id');
 141     $this->assertEquals($result['values'][$result['id']]['contribution_id'], $params['contribution_id'], 'Check Contribution Id');
 142   }
 143
 144 }