api/v3/examples/ContributionSoft/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using contribution_soft get API.
   4  *
   5  *
   6  * @return array
   7  *   API result array
   8  */
   9 function contribution_soft_get_example() {
  10   $params = array(
  11     'id' => 1,
  12   );
  13
  14   try{
  15     $result = civicrm_api3('contribution_soft', 'get', $params);
  16   }
  17   catch (CiviCRM_API3_Exception $e) {
  18     // Handle error here.
  19     $errorMessage = $e->getMessage();
  20     $errorCode = $e->getErrorCode();
  21     $errorData = $e->getExtraParams();
  22     return array(
  23       'error' => $errorMessage,
  24       'error_code' => $errorCode,
  25       'error_data' => $errorData,
  26     );
  27   }
  28
  29   return $result;
  30 }
  31
  32 /**
  33  * Function returns array of result expected from previous function.
  34  *
  35  * @return array
  36  *   API result array
  37  */
  38 function contribution_soft_get_expectedresult() {
  39
  40   $expectedResult = array(
  41     'is_error' => 0,
  42     'version' => 3,
  43     'count' => 1,
  44     'id' => 1,
  45     'values' => array(
  46       '1' => array(
  47         'id' => '1',
  48         'contribution_id' => '1',
  49         'contact_id' => '4',
  50         'amount' => '10.00',
  51         'currency' => 'USD',
  52         'pcp_display_in_roll' => 0,
  53         'soft_credit_type_id' => '4',
  54       ),
  55     ),
  56   );
  57
  58   return $expectedResult;
  59 }
  60
  61 /**
  62 * This example has been generated from the API test suite.
  63 * The test that created it is called
  64 * testGetContributionSoft
  65 * and can be found in
  66 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionSoftTest.php
  67 *
  68 * You can see the outcome of the API tests at
  69 * https://test.civicrm.org/job/CiviCRM-master-git/
  70 *
  71 * To Learn about the API read
  72 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  73 *
  74 * Browse the api on your own site with the api explorer
  75 * http://MYSITE.ORG/path/to/civicrm/api
  76 *
  77 * Read more about testing here
  78 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  79 *
  80 * API Standards documentation:
  81 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  82 */