api/v3/examples/ContributionSoft/Create.ex.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the ContributionSoft.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function contribution_soft_create_example() {
   9   $params = [
  10     'contribution_id' => 6,
  11     'contact_id' => 19,
  12     'amount' => '10',
  13     'currency' => 'USD',
  14     'soft_credit_type_id' => 5,
  15   ];
  16
  17   try{
  18     $result = civicrm_api3('ContributionSoft', 'create', $params);
  19   }
  20   catch (CiviCRM_API3_Exception $e) {
  21     // Handle error here.
  22     $errorMessage = $e->getMessage();
  23     $errorCode = $e->getErrorCode();
  24     $errorData = $e->getExtraParams();
  25     return [
  26       'is_error' => 1,
  27       'error_message' => $errorMessage,
  28       'error_code' => $errorCode,
  29       'error_data' => $errorData,
  30     ];
  31   }
  32
  33   return $result;
  34 }
  35
  36 /**
  37  * Function returns array of result expected from previous function.
  38  *
  39  * @return array
  40  *   API result array
  41  */
  42 function contribution_soft_create_expectedresult() {
  43
  44   $expectedResult = [
  45     'is_error' => 0,
  46     'version' => 3,
  47     'count' => 1,
  48     'id' => 5,
  49     'values' => [
  50       '5' => [
  51         'id' => '5',
  52         'contribution_id' => '6',
  53         'contact_id' => '19',
  54         'amount' => '10',
  55         'currency' => 'USD',
  56         'pcp_id' => '',
  57         'pcp_display_in_roll' => '',
  58         'pcp_roll_nickname' => '',
  59         'pcp_personal_note' => '',
  60         'soft_credit_type_id' => '5',
  61       ],
  62     ],
  63   ];
  64
  65   return $expectedResult;
  66 }
  67
  68 /*
  69 * This example has been generated from the API test suite.
  70 * The test that created it is called "testCreateContributionSoft"
  71 * and can be found at:
  72 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionSoftTest.php
  73 *
  74 * You can see the outcome of the API tests at
  75 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
  76 *
  77 * To Learn about the API read
  78 * https://docs.civicrm.org/dev/en/latest/api/
  79 *
  80 * Browse the API on your own site with the API Explorer. It is in the main
  81 * CiviCRM menu, under: Support > Development > API Explorer.
  82 *
  83 * Read more about testing here
  84 * https://docs.civicrm.org/dev/en/latest/testing/
  85 *
  86 * API Standards documentation:
  87 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
  88 */