Merge branch 'rcsheets-docstring-cleanup'

[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 6ea6c40a6d19304cd955154986d463ce66ea6b73..2ecd6bccf16cf7b79f1a4cd96aaf4a60c15a91d0 100644 (file)
--- a/api/v3/examples/Activity/ContactRefCustomFieldGet.php
+++ b/api/v3/examples/Activity/ContactRefCustomFieldGet.php
@@ -1,43 +1,42 @@
 <?php
-
-/*
- Get with Contact Ref Custom Field
+/**
+ * Test Generated example of using activity get API
+ * Get with Contact Ref Custom Field *
  */
-function activity_create_example(){
-$params = array( 
-  'source_contact_id' => 17,
-  'activity_type_id' => '44',
-  'subject' => 'test activity type id',
-  'activity_date_time' => '2011-06-02 14:36:13',
-  'status_id' => 2,
-  'priority_id' => 1,
-  'duration' => 120,
-  'location' => 'Pensulvania',
-  'details' => 'a test activity',
-  'version' => 3,
-  'custom_2' => '17',
+function activity_get_example(){
+$params = array(
+  'return.custom_2' => 1,
+  'id' => 1,
 );
 
-  $result = civicrm_api( 'activity','create',$params );
+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;
+return $result;
 }
 
-/*
+/**
  * Function returns array of result expected from previous function
  */
-function activity_create_expectedresult(){
+function activity_get_expectedresult(){
 
-  $expectedResult = array( 
+  $expectedResult = array(
   'is_error' => 0,
   'version' => 3,
   'count' => 1,
   'id' => 1,
-  'values' => array( 
-      '1' => array( 
+  'values' => array(
+      '1' => array(
           'id' => '1',
-          'source_contact_id' => '17',
-          'activity_type_id' => '44',
+          'activity_type_id' => '46',
           'subject' => 'test activity type id',
           'activity_date_time' => '2011-06-02 14:36:13',
           'duration' => '120',
@@ -49,15 +48,18 @@ function activity_create_expectedresult(){
           'is_auto' => 0,
           'is_current_revision' => '1',
           'is_deleted' => 0,
-          'custom_2_id' => '17',
-          'custom_2_1_id' => '17',
-          'custom_2' => 'Contact, Test',
-          'custom_2_1' => 'Contact, Test',
+          'source_contact_id' => '1',
+          'custom_1' => 'defaultValue',
+          'custom_1_1' => 'defaultValue',
+          'custom_2_id' => '1',
+          'custom_2_1_id' => '1',
+          'custom_2' => 'Anderson, Anthony',
+          'custom_2_1' => 'Anderson, Anthony',
         ),
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -65,20 +67,20 @@ function activity_create_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testActivityCreateCustomContactRefField and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ActivityTest.php
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.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/explorer
 *
 * 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
+*/