CRM-15988 - Update generated examples

[civicrm-core.git] / api / v3 / examples / MailSettings / Delete.php

diff --git a/api/v3/examples/MailSettings/Delete.php b/api/v3/examples/MailSettings/Delete.php
index 482d9c33969e864cbbb01f16b1e69ed843004ef1..14cf3ba324e46e3406bb7bbe21c342d011e5ef1c 100644 (file)
--- a/api/v3/examples/MailSettings/Delete.php
+++ b/api/v3/examples/MailSettings/Delete.php
@@ -1,47 +1,55 @@
 <?php
 /**
- * Test Generated example of using mail_settings delete API
- * *
+ * Test Generated example demonstrating the MailSettings.delete API.
+ *
+ * @return array
+ *   API result array
  */
-function mail_settings_delete_example(){
-$params = array(
-  'id' => 5,
-);
+function mail_settings_delete_example() {
+  $params = array(
+    'id' => 5,
+  );
 
-try{
-  $result = civicrm_api3('mail_settings', 'delete', $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('MailSettings', 'delete', $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,
+    );
+  }
 
-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 mail_settings_delete_expectedresult(){
+function mail_settings_delete_expectedresult() {
 
   $expectedResult = array(
-  'is_error' => 0,
-  'version' => 3,
-  'count' => 1,
-  'values' => 1,
-);
+    '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
-*
-* testDeleteMailSettings and can be found in
+* This example has been generated from the API test suite.
+* The test that created it is called "testDeleteMailSettings"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailSettingsTest.php
 *
 * You can see the outcome of the API tests at
@@ -51,7 +59,7 @@ function mail_settings_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