Update test examples.

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

diff --git a/api/v3/examples/Contact/CustomFieldGet.php b/api/v3/examples/Contact/CustomFieldGet.php
index 7076ac73739e9fed188a70387be700d783ba203f..ac3e7b3ab680e3b414474c874456e90bda1c4a96 100644 (file)
--- a/api/v3/examples/Contact/CustomFieldGet.php
+++ b/api/v3/examples/Contact/CustomFieldGet.php
@@ -1,70 +1,81 @@
 <?php
 /**
- * Test Generated example of using contact get API
- * /*this demonstrates setting a custom field through the API  *
+ * Test Generated example demonstrating the Contact.get API.
+ *
+ * This demonstrates setting a custom field through the API.
+ *
+ * @return array
+ *   API result array
  */
-function contact_get_example(){
-$params = array(
-  'return.custom_1' => 1,
-  'id' => 1,
-);
+function contact_get_example() {
+  $params = array(
+    'return.custom_1' => 1,
+    'id' => 1,
+  );
 
-try{
-  $result = civicrm_api3('contact', '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('Contact', '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 contact_get_expectedresult(){
+function contact_get_expectedresult() {
 
   $expectedResult = array(
-  'is_error' => 0,
-  'version' => 3,
-  'count' => 1,
-  'id' => 1,
-  'values' => array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 1,
+    'values' => array(
       '1' => array(
-          'contact_id' => '1',
-          'civicrm_value_testgetwithcu_1_id' => '1',
-          'custom_1' => 'custom string',
-          'id' => '1',
-        ),
+        'contact_id' => '1',
+        'civicrm_value_testgetwithcu_1_id' => '1',
+        'custom_1' => 'custom string',
+        'id' => '1',
+      ),
     ),
-);
+  );
 
   return $expectedResult;
 }
 
-
 /*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testGetWithCustom and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetWithCustom"
+* 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
-* http://tests.dev.civicrm.org/trunk/results-api_v3
+* https://test.civicrm.org/job/CiviCRM-master-git/
 *
 * To Learn about the API read
-* http://book.civicrm.org/developer/current/techniques/api/
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 *
-* and review the wiki at
-* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
 *
 * Read more about testing here
 * http://wiki.civicrm.org/confluence/display/CRM/Testing
 *
 * API Standards documentation:
 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
-*/
\ No newline at end of file
+*/