Merge pull request #6289 from yashodha/CRM-16879

[civicrm-core.git] / tests / phpunit / api / v3 / ContributionSoftTest.php

diff --git a/tests/phpunit/api/v3/ContributionSoftTest.php b/tests/phpunit/api/v3/ContributionSoftTest.php
index 92af8cdb01939c76824cacc3c4d7ab013b9d1f47..bbe03ca8137de87c733167f2bcdccfb8354db1b0 100644 (file)
--- a/tests/phpunit/api/v3/ContributionSoftTest.php
+++ b/tests/phpunit/api/v3/ContributionSoftTest.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,21 +23,20 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 require_once 'CiviTest/CiviUnitTestCase.php';
 
 /**
  *  Test APIv3 civicrm_contribute_* functions
  *
- *  @package CiviCRM_APIv3
- *  @subpackage API_ContributionSoft
+ * @package CiviCRM_APIv3
+ * @subpackage API_ContributionSoft
  */
-
 class api_v3_ContributionSoftTest extends CiviUnitTestCase {
 
   /**
-   * Assume empty database with just civicrm_data
+   * Assume empty database with just civicrm_data.
    */
   protected $_individualId; //the hard credit contact
   protected $_softIndividual1Id; //the first soft credit contact
@@ -64,7 +63,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
       'contact_id' => $this->_individualId,
       'receive_date' => '20120511',
       'total_amount' => 100.00,
-      'financial_type_id'   => $this->_financialTypeId,
+      'financial_type_id' => $this->_financialTypeId,
       'non_deductible_amount' => 10.00,
       'fee_amount' => 5.00,
       'net_amount' => 95.00,
@@ -85,7 +84,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
   }
 
   /**
-   * Test get methods
+   * Test get methods.
    * @todo - this might be better broken down into more smaller tests
    */
   public function testGetContributionSoft() {
@@ -112,30 +111,31 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
 
     //create a second soft contribution on the same hard contribution - we are testing that 'id' gets the right soft contribution id (not the contribution id)
     $p['contact_id'] = $this->_softIndividual2Id;
-    $this->_softcontribution2 =  $this->callAPISuccess('contribution_soft', 'create', $p);
+    $this->_softcontribution2 = $this->callAPISuccess('contribution_soft', 'create', $p);
 
     // now we have 2 - test getcount
-    $softcontribution =  $this->callAPISuccess('contribution_soft', 'getcount', array());
+    $softcontribution = $this->callAPISuccess('contribution_soft', 'getcount', array());
     $this->assertEquals(2, $softcontribution);
 
     //check first contribution
-    $result =  $this->callAPISuccess('contribution_soft', 'get', array(
+    $result = $this->callAPISuccess('contribution_soft', 'get', array(
       'id' => $this->_softcontribution['id'],
     ));
     $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
     $this->assertEquals($this->_softcontribution['id'], $result['id']);
-    $this->assertEquals($this->_softcontribution['id'], $result['id'], print_r($softcontribution,true));
+    $this->assertEquals($this->_softcontribution['id'], $result['id'], print_r($softcontribution, TRUE));
 
     //test id only format - second soft credit
-    $resultID2 =  $this->callAPISuccess('contribution_soft', 'get', array(
+    $resultID2 = $this->callAPISuccess('contribution_soft', 'get', array(
       'id' => $this->_softcontribution2['id'],
       'format.only_id' => 1,
     ));
     $this->assertEquals($this->_softcontribution2['id'], $resultID2);
 
     //test get by contact id works
-    $result =  $this->callAPISuccess('contribution_soft', 'get', array(
-      'contact_id' => $this->_softIndividual2Id)
+    $result = $this->callAPISuccess('contribution_soft', 'get', array(
+        'contact_id' => $this->_softIndividual2Id,
+      )
     );
     $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
 
@@ -147,15 +147,17 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
     $this->callAPISuccess('contribution_soft', 'getcount', array(), $expectedCount);
 
     //check id is same as 2
-    $this->assertEquals($this->_softcontribution2['id'], $this->callAPISuccess('contribution_soft', 'getvalue', array('return' => 'id' )));
+    $this->assertEquals($this->_softcontribution2['id'], $this->callAPISuccess('contribution_soft', 'getvalue', array('return' => 'id')));
 
     $this->callAPISuccess('ContributionSoft', 'Delete', array(
       'id' => $this->_softcontribution2['id'],
-     ));
+    ));
   }
 
 
-  ///////////////// civicrm_contribution_soft
+  /**
+   * civicrm_contribution_soft.
+   */
   public function testCreateEmptyParamsContributionSoft() {
     $softcontribution = $this->callAPIFailure('contribution_soft', 'create', array(),
       'Mandatory key(s) missing from params array: contribution_id, amount, contact_id'
@@ -169,7 +171,6 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
   }
 
   public function testCreateContributionSoftInvalidContact() {
-
     $params = array(
       'contact_id' => 999,
       'contribution_id' => $this->_contributionId,
@@ -183,7 +184,6 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
   }
 
   public function testCreateContributionSoftInvalidContributionId() {
-
     $params = array(
       'contribution_id' => 999999,
       'contact_id' => $this->_softIndividual1Id,
@@ -196,8 +196,8 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
     );
   }
 
-  /*
-   * Function tests that additional financial records are created when fee amount is recorded
+  /**
+   * Function tests that additional financial records are created when fee amount is recorded.
    */
   public function testCreateContributionSoft() {
     $params = array(
@@ -216,7 +216,10 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
     $this->assertEquals($softcontribution['values'][$softcontribution['id']]['soft_credit_type_id'], 5, 'In line ' . __LINE__);
   }
 
-  //To Update Soft Contribution
+  /**
+   * To Update Soft Contribution.
+   *
+   */
   public function testCreateUpdateContributionSoft() {
     //create a soft credit
     $params = array(
@@ -248,7 +251,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
     $this->assertEquals($old_contact_id, $this->_softIndividual1Id, 'In line ' . __LINE__);
     $this->assertEquals($old_amount, 10.00, 'In line ' . __LINE__);
     $this->assertEquals($old_currency, 'USD', 'In line ' . __LINE__);
-    $this->assertEquals($old_soft_credit_type_id, 6 , 'In line ' . __LINE__);
+    $this->assertEquals($old_soft_credit_type_id, 6, 'In line ' . __LINE__);
     $params = array(
       'id' => $softcontributionID,
       'contribution_id' => $this->_contributionId,
@@ -277,7 +280,10 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
     $result = $this->callAPISuccess('contribution_soft', 'delete', $params);
   }
 
-  ///////////////// civicrm_contribution_soft_delete methods
+  /**
+   * civicrm_contribution_soft_delete methods.
+   *
+   */
   public function testDeleteEmptyParamsContributionSoft() {
     $params = array();
     $softcontribution = $this->callAPIFailure('contribution_soft', 'delete', $params);
@@ -310,8 +316,8 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
   ///////////////// civicrm_contribution_search methods
 
   /**
-   *  Test civicrm_contribution_search with empty params.
-   *  All available contributions expected.
+   * Test civicrm_contribution_search with empty params.
+   * All available contributions expected.
    */
   public function testSearchEmptyParams() {
     $p = array(
@@ -333,7 +339,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
   }
 
   /**
-   *  Test civicrm_contribution_soft_search. Success expected.
+   * Test civicrm_contribution_soft_search. Success expected.
    */
   public function testSearch() {
     $p1 = array(
@@ -361,6 +367,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase {
     $this->assertEquals($p2['contribution_id'], $res['contribution_id'], 'In line ' . __LINE__);
     $this->assertEquals($p2['contact_id'], $res['contact_id'], 'In line ' . __LINE__);
     $this->assertEquals($p2['amount'], $res['amount'], 'In line ' . __LINE__);
-    $this->assertEquals($p2['currency'], $res['currency'], 'In line ' . __LINE__ );
+    $this->assertEquals($p2['currency'], $res['currency'], 'In line ' . __LINE__);
   }
+
 }