update examples"

[civicrm-core.git] / api / v3 / examples / Activity / ContactRefCustomFieldGet.php

diff --git a/api/v3/examples/Activity/ContactRefCustomFieldGet.php b/api/v3/examples/Activity/ContactRefCustomFieldGet.php
index cdd214c6f7d8fab3949fb7496295b33d310b4287..18273b9bf8612a3f78a0148565d3597f081702e7 100644 (file)
--- a/api/v3/examples/Activity/ContactRefCustomFieldGet.php
+++ b/api/v3/examples/Activity/ContactRefCustomFieldGet.php
@@ -1,72 +1,89 @@
 <?php
 /**
- * Test Generated example of using activity get API
- * Get with Contact Ref Custom Field *
+ * @file
+ * Test Generated API Example.
+ * See bottom of this file for more detail.
  */
-function activity_get_example(){
-$params = array(
-  'return.custom_2' => 1,
-  'id' => 1,
-);
 
-try{
-  $result = civicrm_api3('activity', '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);
-}
+/**
+ * Test Generated example of using activity get API.
+ *
+ * Get with Contact Ref Custom Field
+ *
+ * @return array
+ *   API result array
+ */
+function activity_get_example() {
+  $params = array(
+    'return.custom_2' => 1,
+    'id' => 1,
+  );
 
-return $result;
+  try{
+    $result = civicrm_api3('activity', '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,
+    );
+  }
+
+  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 activity_get_expectedresult(){
+function activity_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(
-          'id' => '1',
-          'activity_type_id' => '49',
-          'subject' => 'test activity type id',
-          'activity_date_time' => '2011-06-02 14:36:13',
-          'duration' => '120',
-          'location' => 'Pensulvania',
-          'details' => 'a test activity',
-          'status_id' => '2',
-          'priority_id' => '1',
-          'is_test' => 0,
-          'is_auto' => 0,
-          'is_current_revision' => '1',
-          'is_deleted' => 0,
-          'source_contact_id' => '1',
-          'custom_1' => 'defaultValue',
-          'custom_1_1' => 'defaultValue',
-          'custom_2' => 'Anderson, Anthony',
-          'custom_2_1' => 'Anderson, Anthony',
-          'custom_2_1_id' => '1',
-          'custom_2_id' => '1',
-        ),
+        'id' => '1',
+        'activity_type_id' => '51',
+        'subject' => 'test activity type id',
+        'activity_date_time' => '2011-06-02 14:36:13',
+        'duration' => '120',
+        'location' => 'Pensulvania',
+        'details' => 'a test activity',
+        'status_id' => '2',
+        'priority_id' => '1',
+        'is_test' => 0,
+        'is_auto' => 0,
+        'is_current_revision' => '1',
+        'is_deleted' => 0,
+        'source_contact_id' => '1',
+        'custom_1' => 'defaultValue',
+        'custom_1_1' => 'defaultValue',
+        'custom_2' => 'Anderson, Anthony',
+        'custom_2_1' => 'Anderson, Anthony',
+        'custom_2_1_id' => '1',
+        'custom_2_id' => '1',
+      ),
     ),
-);
+  );
 
   return $expectedResult;
 }
 
-
-/*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testActivityCreateCustomContactRefField and can be found in
+/**
+* This example has been generated from the API test suite.
+* The test that created it is called
+* testActivityCreateCustomContactRefField
+* and can be found in
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php
 *
 * You can see the outcome of the API tests at