Merge pull request #2704 from jitendrapurohit/CRM_TestFix
[civicrm-core.git] / api / v3 / examples / Contact / CustomFieldGet.php
index 5806b7cb4c29ad3e011ecbdfa2a76fcc0128308f..14a0fccf3b67071317906d346c27605f49228fb0 100644 (file)
@@ -1,23 +1,29 @@
 <?php
-
-/*
- /*this demonstrates setting a custom field through the API 
+/**
+ * Test Generated example of using contact get API
+ * /*this demonstrates setting a custom field through the API  *
  */
 function contact_get_example(){
 $params = array(
-  'first_name' => 'abc1',
-  'contact_type' => 'Individual',
-  'last_name' => 'xyz1',
-  'version' => 3,
-  'custom_3' => 'custom string',
+  'return.custom_1' => 1,
+  'id' => 1,
 );
 
-  $result = civicrm_api( 'contact','get',$params );
+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);
+}
 
-  return $result;
+return $result;
 }
 
-/*
+/**
  * Function returns array of result expected from previous function
  */
 function contact_get_expectedresult(){
@@ -30,14 +36,14 @@ function contact_get_expectedresult(){
   'values' => array(
       '1' => array(
           'contact_id' => '1',
-          'civicrm_value_testgetwithcu_3_id' => '1',
-          'custom_3' => 'custom string',
+          'civicrm_value_testgetwithcu_1_id' => '1',
+          'custom_1' => 'custom string',
           'id' => '1',
         ),
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -45,20 +51,20 @@ function contact_get_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
+* 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/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
+*/