updated examples

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

diff --git a/api/v3/examples/ActivityGetfields.php b/api/v3/examples/ActivityGetfields.php
index 813cbd49b1f6a189468fc7320cf47a699ab5fbfe..14ec4f1799e40df6eb40da37f8764ddae84ed0ed 100644 (file)
--- a/api/v3/examples/ActivityGetfields.php
+++ b/api/v3/examples/ActivityGetfields.php
@@ -1,20 +1,28 @@
 <?php
-
-/*
- 
+/**
+ * Test Generated example of using activity getfields API
+ * *
  */
 function activity_getfields_example(){
 $params = array(
-  'version' => 3,
   'action' => 'create',
 );
 
-  $result = civicrm_api( 'activity','getfields',$params );
+try{
+  $result = civicrm_api3('activity', 'getfields', $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_getfields_expectedresult(){
@@ -37,12 +45,10 @@ function activity_getfields_expectedresult(){
           'import' => true,
           'where' => 'civicrm_activity.activity_type_id',
           'headerPattern' => '/(activity.)?type(.id$)/i',
+          'default' => '1',
           'pseudoconstant' => array(
               'optionGroupName' => 'activity_type',
             ),
-          'api.aliases' => array(
-              '0' => 'activity_type',
-            ),
         ),
       'activity_date_time' => array(
           'name' => 'activity_date_time',
@@ -73,9 +79,6 @@ function activity_getfields_expectedresult(){
           'pseudoconstant' => array(
               'optionGroupName' => 'priority',
             ),
-          'api.aliases' => array(
-              '0' => 'priority',
-            ),
         ),
       'parent_id' => array(
           'name' => 'parent_id',
@@ -92,7 +95,7 @@ function activity_getfields_expectedresult(){
           'name' => 'relationship_id',
           'type' => 1,
           'title' => 'Relationship Id',
-          'default' => 'UL',
+          'default' => 'NULL',
           'FKClassName' => 'CRM_Contact_DAO_Relationship',
         ),
       'is_current_revision' => array(
@@ -103,6 +106,7 @@ function activity_getfields_expectedresult(){
           'where' => 'civicrm_activity.is_current_revision',
           'headerPattern' => '/(is.)?(current.)?(revision|version(ing)?)/i',
           'export' => true,
+          'default' => '1',
         ),
       'original_id' => array(
           'name' => 'original_id',
@@ -186,7 +190,7 @@ function activity_getfields_expectedresult(){
             ),
           'uniqueName' => 'activity_status_id',
           'api.aliases' => array(
-              '0' => 'status',
+              '0' => 'activity_status',
             ),
         ),
       'is_test' => array(
@@ -203,14 +207,11 @@ function activity_getfields_expectedresult(){
           'name' => 'medium_id',
           'type' => 1,
           'title' => 'Activity Medium',
-          'default' => 'UL',
+          'default' => 'NULL',
           'pseudoconstant' => array(
               'optionGroupName' => 'encounter_medium',
             ),
           'uniqueName' => 'activity_medium_id',
-          'api.aliases' => array(
-              '0' => 'medium',
-            ),
         ),
       'result' => array(
           'name' => 'result',
@@ -233,11 +234,16 @@ function activity_getfields_expectedresult(){
       'campaign_id' => array(
           'name' => 'campaign_id',
           'type' => 1,
-          'title' => 'Campaign ID',
+          'title' => 'Campaign',
           'import' => true,
           'where' => 'civicrm_activity.campaign_id',
           'export' => true,
           'FKClassName' => 'CRM_Campaign_DAO_Campaign',
+          'pseudoconstant' => array(
+              'table' => 'civicrm_campaign',
+              'keyColumn' => 'id',
+              'labelColumn' => 'title',
+            ),
           'uniqueName' => 'activity_campaign_id',
         ),
       'engagement_level' => array(
@@ -274,7 +280,7 @@ function activity_getfields_expectedresult(){
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -298,4 +304,4 @@ function activity_getfields_expectedresult(){
 *
 * API Standards documentation:
 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
-*/
\ No newline at end of file
+*/