Short array syntax - auto-convert api dir
[civicrm-core.git] / api / v3 / examples / ContributionSoft / Create.php
index 00e20b2b076cfefb8cc2809088b60476d0003007..523683a58f1573ae894e82ea18ab9ac676bf7000 100644 (file)
@@ -1,39 +1,33 @@
 <?php
 /**
- * @file
- * Test Generated API Example.
- * See bottom of this file for more detail.
- */
-
-/**
- * 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(
+  $params = [
     'contribution_id' => 6,
     'contact_id' => 19,
     'amount' => '10',
     'currency' => 'USD',
     'soft_credit_type_id' => 5,
-  );
+  ];
 
   try{
-    $result = civicrm_api3('contribution_soft', 'create', $params);
+    $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(
-      'error' => $errorMessage,
+    return [
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
-    );
+    ];
   }
 
   return $result;
@@ -47,13 +41,13 @@ function contribution_soft_create_example() {
  */
 function contribution_soft_create_expectedresult() {
 
-  $expectedResult = array(
+  $expectedResult = [
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
     'id' => 5,
-    'values' => array(
-      '5' => array(
+    'values' => [
+      '5' => [
         'id' => '5',
         'contribution_id' => '6',
         'contact_id' => '19',
@@ -64,18 +58,17 @@ function contribution_soft_create_expectedresult() {
         '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
+* 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
@@ -85,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