Short array syntax - auto-convert api dir

[civicrm-core.git] / api / v3 / examples / Contact / FormatSingleValue.php

diff --git a/api/v3/examples/Contact/FormatSingleValue.php b/api/v3/examples/Contact/FormatSingleValue.php
index 8678de3c844f2d5397d36783325f8e2541d62536..fa3f23783e4e0c6dc6b0b7f7a6f59d074d411bf7 100644 (file)
--- a/api/v3/examples/Contact/FormatSingleValue.php
+++ b/api/v3/examples/Contact/FormatSingleValue.php
@@ -1,39 +1,34 @@
 <?php
 /**
- * @file
- * Test Generated API Example.
- * See bottom of this file for more detail.
- */
-
-/**
- * Test Generated example of using contact getvalue API.
+ * Test Generated example demonstrating the Contact.getvalue API.
  *
  * This demonstrates use of the 'format.single_value' param.
-    /* This param causes only a single value of the only entity to be returned as an string.
-    /* it will be ignored if there is not exactly 1 result
+ * This param causes only a single value of the only entity to be returned as an string.
+ * It will be ignored if there is not exactly 1 result
  *
  * @return array
  *   API result array
  */
 function contact_getvalue_example() {
-  $params = array(
+  $params = [
     'id' => 17,
     'return' => 'display_name',
-  );
+  ];
 
   try{
-    $result = civicrm_api3('contact', 'getvalue', $params);
+    $result = civicrm_api3('Contact', 'getvalue', $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;
@@ -52,11 +47,10 @@ function contact_getvalue_expectedresult() {
   return $expectedResult;
 }
 
-/**
+/*
 * This example has been generated from the API test suite.
-* The test that created it is called
-* testContactGetFormatSingleValue
-* and can be found in
+* The test that created it is called "testContactGetFormatSingleValue"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
 *
 * You can see the outcome of the API tests at
@@ -66,7 +60,7 @@ function contact_getvalue_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