api/v3/examples/ContributionSoftDelete.php

   1 <?php
   2 /**
   3  * Test Generated example of using contribution_soft delete API
   4  * *
   5  */
   6 function contribution_soft_delete_example(){
   7 $params = array(
   8   'id' => 1,
   9 );
  10
  11 try{
  12   $result = civicrm_api3('contribution_soft', 'delete', $params);
  13 }
  14 catch (CiviCRM_API3_Exception $e) {
  15   // handle error here
  16   $errorMessage = $e->getMessage();
  17   $errorCode = $e->getErrorCode();
  18   $errorData = $e->getExtraParams();
  19   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  20 }
  21
  22 return $result;
  23 }
  24
  25 /**
  26  * Function returns array of result expected from previous function
  27  */
  28 function contribution_soft_delete_expectedresult(){
  29
  30   $expectedResult = '';
  31
  32   return $expectedResult;
  33 }
  34
  35
  36 /*
  37 * This example has been generated from the API test suite. The test that created it is called
  38 *
  39 * testDeleteContributionSoft and can be found in
  40 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContributionSoftTest.php
  41 *
  42 * You can see the outcome of the API tests at
  43 * http://tests.dev.civicrm.org/trunk/results-api_v3
  44 *
  45 * To Learn about the API read
  46 * http://book.civicrm.org/developer/current/techniques/api/
  47 *
  48 * and review the wiki at
  49 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  50 *
  51 * Read more about testing here
  52 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  53 *
  54 * API Standards documentation:
  55 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  56 */