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