Merge pull request #9724 from civicrm/michaelmcandrew-CRM-19921

[civicrm-core.git] / api / v3 / examples / ContributionSoft / Create.php

diff --git a/api/v3/examples/ContributionSoft/Create.php b/api/v3/examples/ContributionSoft/Create.php
index ff9f74771828c233eda248b8c513e5f436dbc74a..8450990dfc2409e9301cd7079452d8f08f44465b 100644 (file)
--- a/api/v3/examples/ContributionSoft/Create.php
+++ b/api/v3/examples/ContributionSoft/Create.php
@@ -1,65 +1,74 @@
 <?php
 /**
- * Test Generated example of using contribution_soft create API
- * *
+ * Test Generated example demonstrating the ContributionSoft.create API.
+ *
+ * @return array
+ *   API result array
  */
-function contribution_soft_create_example(){
-$params = array(
-  'contribution_id' => 1,
-  'contact_id' => 2,
-  'amount' => '10',
-  'currency' => 'USD',
-  'soft_credit_type_id' => 5,
-);
+function contribution_soft_create_example() {
+  $params = array(
+    'contribution_id' => 6,
+    'contact_id' => 19,
+    'amount' => '10',
+    'currency' => 'USD',
+    'soft_credit_type_id' => 5,
+  );
 
-try{
-  $result = civicrm_api3('contribution_soft', 'create', $params);
-}
-catch (CiviCRM_API3_Exception $e) {
-  // handle error here
-  $errorMessage = $e->getMessage();
-  $errorCode = $e->getErrorCode();
-  $errorData = $e->getExtraParams();
-  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
-}
+  try{
+    $result = civicrm_api3('ContributionSoft', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
 
-return $result;
+  return $result;
 }
 
 /**
- * Function returns array of result expected from previous function
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
  */
-function contribution_soft_create_expectedresult(){
+function contribution_soft_create_expectedresult() {
 
   $expectedResult = array(
-  'is_error' => 0,
-  'version' => 3,
-  'count' => 1,
-  'id' => 1,
-  'values' => array(
-      '1' => array(
-          'id' => '1',
-          'contribution_id' => '1',
-          'contact_id' => '2',
-          'amount' => '10',
-          'currency' => 'USD',
-          'pcp_id' => '',
-          'pcp_display_in_roll' => '',
-          'pcp_roll_nickname' => '',
-          'pcp_personal_note' => '',
-          'soft_credit_type_id' => '5',
-        ),
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 5,
+    'values' => array(
+      '5' => array(
+        'id' => '5',
+        'contribution_id' => '6',
+        'contact_id' => '19',
+        'amount' => '10',
+        'currency' => 'USD',
+        'pcp_id' => '',
+        'pcp_display_in_roll' => '',
+        'pcp_roll_nickname' => '',
+        'pcp_personal_note' => '',
+        'soft_credit_type_id' => '5',
+      ),
     ),
-);
+  );
 
   return $expectedResult;
 }
 
-
 /*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testCreateContributionSoft and can be found in
+* This example has been generated from the API test suite.
+* The test that created it is called "testCreateContributionSoft"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionSoftTest.php
 *
 * You can see the outcome of the API tests at
@@ -69,7 +78,7 @@ function contribution_soft_create_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