Short array syntax - auto-convert api dir

[civicrm-core.git] / api / v3 / examples / Setting / Get.php

diff --git a/api/v3/examples/Setting/Get.php b/api/v3/examples/Setting/Get.php
index 812b9c71e041879fde9618a1ea7afe05027ba031..74d9c9a03b85e45ebab003580be1469a2a497db1 100644 (file)
--- a/api/v3/examples/Setting/Get.php
+++ b/api/v3/examples/Setting/Get.php
@@ -1,36 +1,30 @@
 <?php
 /**
- * @file
- * Test Generated API Example.
- * See bottom of this file for more detail.
- */
-
-/**
- * Test Generated example of using setting get API.
- *
+ * Test Generated example demonstrating the Setting.get API.
  *
  * @return array
  *   API result array
  */
 function setting_get_example() {
-  $params = array(
+  $params = [
     'domain_id' => 2,
     'return' => 'uniq_email_per_site',
-  );
+  ];
 
   try{
-    $result = civicrm_api3('setting', 'get', $params);
+    $result = civicrm_api3('Setting', 'get', $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;
@@ -44,26 +38,25 @@ function setting_get_example() {
  */
 function setting_get_expectedresult() {
 
-  $expectedResult = array(
+  $expectedResult = [
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
     'id' => 2,
-    'values' => array(
-      '2' => array(
+    'values' => [
+      '2' => [
         'uniq_email_per_site' => '1',
-      ),
-    ),
-  );
+      ],
+    ],
+  ];
 
   return $expectedResult;
 }
 
-/**
+/*
 * This example has been generated from the API test suite.
-* The test that created it is called
-* testGetSetting
-* and can be found in
+* The test that created it is called "testGetSetting"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
 *
 * You can see the outcome of the API tests at
@@ -73,7 +66,7 @@ function setting_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