api/v3/examples/ContributionDelete.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function contribution_delete_example(){
   7 $params = array(
   8   'id' => 1,
   9   'version' => 3,
  10 );
  11
  12   $result = civicrm_api( 'contribution','delete',$params );
  13
  14   return $result;
  15 }
  16
  17 /*
  18  * Function returns array of result expected from previous function
  19  */
  20 function contribution_delete_expectedresult(){
  21
  22   $expectedResult = array(
  23   'is_error' => 0,
  24   'version' => 3,
  25   'count' => 1,
  26   'id' => 1,
  27   'values' => array(
  28       '1' => 1,
  29     ),
  30 );
  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 * testDeleteContribution and can be found in
  40 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContributionTest.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 */