Update Test generated examples
[civicrm-core.git] / api / v3 / examples / Contribution / Delete.php
index dea4e1e41925ee7b664526e98e0a65c7900020a9..c22b1b102d2219623ce027337592c4b5ae5fc69f 100644 (file)
@@ -1,13 +1,6 @@
 <?php
 /**
- * @file
- * Test Generated API Example.
- * See bottom of this file for more detail.
- */
-
-/**
- * Test Generated example of using contribution delete API.
- *
+ * Test Generated example demonstrating the Contribution.delete API.
  *
  * @return array
  *   API result array
@@ -18,7 +11,7 @@ function contribution_delete_example() {
   );
 
   try{
-    $result = civicrm_api3('contribution', 'delete', $params);
+    $result = civicrm_api3('Contribution', 'delete', $params);
   }
   catch (CiviCRM_API3_Exception $e) {
     // Handle error here.
@@ -26,7 +19,8 @@ function contribution_delete_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -56,11 +50,10 @@ function contribution_delete_expectedresult() {
   return $expectedResult;
 }
 
-/**
+/*
 * This example has been generated from the API test suite.
-* The test that created it is called
-* testDeleteContribution
-* and can be found in
+* The test that created it is called "testDeleteContribution"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php
 *
 * You can see the outcome of the API tests at
@@ -70,7 +63,7 @@ function contribution_delete_expectedresult() {
 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 *
 * Browse the api on your own site with the api explorer
-* http://MYSITE.ORG/path/to/civicrm/api/explorer
+* http://MYSITE.ORG/path/to/civicrm/api
 *
 * Read more about testing here
 * http://wiki.civicrm.org/confluence/display/CRM/Testing