api/v3/examples/ContributionSoft/Create.php

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