Merge pull request #9769 from scardinius/crm-19958

[civicrm-core.git] / api / v3 / examples / Survey / ChainedGetDelete.php

diff --git a/api/v3/examples/Survey/ChainedGetDelete.php b/api/v3/examples/Survey/ChainedGetDelete.php
index 6ef6402f3029c8d31f16a9467270d934f05b3540..860366008bd5dee54826408773d33e276ccd91c4 100644 (file)
--- a/api/v3/examples/Survey/ChainedGetDelete.php
+++ b/api/v3/examples/Survey/ChainedGetDelete.php
@@ -1,68 +1,79 @@
 <?php
 /**
- * Test Generated example of using survey get API
- * demonstrates get + delete in the same call *
+ * Test Generated example demonstrating the Survey.get API.
+ *
+ * Demonstrates get + delete in the same call.
+ *
+ * @return array
+ *   API result array
  */
-function survey_get_example(){
-$params = array(
-  'title' => 'survey title',
-  'api.survey.delete' => 1,
-);
+function survey_get_example() {
+  $params = array(
+    'title' => 'survey title',
+    'api.survey.delete' => 1,
+  );
 
-try{
-  $result = civicrm_api3('survey', 'get', $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('Survey', 'get', $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 survey_get_expectedresult(){
+function survey_get_expectedresult() {
 
   $expectedResult = array(
-  'is_error' => 0,
-  'version' => 3,
-  'count' => 1,
-  'id' => 1,
-  'values' => array(
-      '1' => array(
-          'id' => '1',
-          'title' => 'survey title',
-          'activity_type_id' => '30',
-          'instructions' => 'Call people, ask for money',
-          'max_number_of_contacts' => '12',
-          'is_active' => '1',
-          'is_default' => 0,
-          'created_date' => '2013-07-28 08:49:19',
-          'bypass_confirm' => 0,
-          'is_share' => '1',
-          'api.survey.delete' => array(
-              'is_error' => 0,
-              'version' => 3,
-              'count' => 1,
-              'values' => true,
-            ),
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 4,
+    'values' => array(
+      '4' => array(
+        'id' => '4',
+        'title' => 'survey title',
+        'activity_type_id' => '30',
+        'instructions' => 'Call people, ask for money',
+        'max_number_of_contacts' => '12',
+        'is_active' => '1',
+        'is_default' => 0,
+        'created_date' => '2013-07-28 08:49:19',
+        'bypass_confirm' => 0,
+        'is_share' => '1',
+        'api.survey.delete' => array(
+          'is_error' => 0,
+          'version' => 3,
+          'count' => 1,
+          'values' => 1,
         ),
+      ),
     ),
-);
+  );
 
   return $expectedResult;
 }
 
-
 /*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testGetSurveyChainDelete and can be found in
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetSurveyChainDelete"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SurveyTest.php
 *
 * You can see the outcome of the API tests at
@@ -72,7 +83,7 @@ function survey_get_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