Merge pull request #2704 from jitendrapurohit/CRM_TestFix

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

diff --git a/api/v3/examples/Contact/GetSingleContact.php b/api/v3/examples/Contact/GetSingleContact.php
index 95126339556a777bf61ca5fe7bf31d55383902c9..d0d1f09b1e4a43a723fb88cef8d7fedafe01dfe1 100644 (file)
--- a/api/v3/examples/Contact/GetSingleContact.php
+++ b/api/v3/examples/Contact/GetSingleContact.php
@@ -1,22 +1,30 @@
 <?php
-
-/*
- This demonstrates use of the 'format.single_entity_array' param.
+/**
+ * Test Generated example of using contact getsingle API
+ * This demonstrates use of the 'format.single_entity_array' param.
     /* This param causes the only contact to be returned as an array without the other levels.
-    /* it will be ignored if there is not exactly 1 result
+    /* it will be ignored if there is not exactly 1 result *
  */
 function contact_getsingle_example(){
 $params = array(
-  'version' => 3,
   'id' => 17,
 );
 
-  $result = civicrm_api( 'contact','getsingle',$params );
+try{
+  $result = civicrm_api3('contact', 'getsingle', $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_getsingle_expectedresult(){
@@ -38,11 +46,16 @@ function contact_getsingle_expectedresult(){
   'nick_name' => '',
   'legal_name' => '',
   'image_URL' => '',
+  'preferred_communication_method' => '',
+  'preferred_language' => '',
   'preferred_mail_format' => '',
   'first_name' => 'Test',
   'middle_name' => '',
   'last_name' => 'Contact',
+  'prefix_id' => '',
+  'suffix_id' => '',
   'job_title' => '',
+  'gender_id' => '',
   'birth_date' => '',
   'is_deceased' => 0,
   'deceased_date' => '',
@@ -61,10 +74,7 @@ function contact_getsingle_expectedresult(){
   'geo_code_1' => '',
   'geo_code_2' => '',
   'state_province_id' => '',
-  'state_province_name' => '',
-  'state_province' => '',
   'country_id' => '',
-  'country' => '',
   'phone_id' => '',
   'phone_type_id' => '',
   'phone' => '',
@@ -76,10 +86,16 @@ function contact_getsingle_expectedresult(){
   'im' => '',
   'worldregion_id' => '',
   'world_region' => '',
+  'individual_prefix' => '',
+  'individual_suffix' => '',
+  'gender' => '',
+  'state_province_name' => '',
+  'state_province' => '',
+  'country' => '',
   'id' => '17',
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -87,20 +103,20 @@ function contact_getsingle_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testContactGetSingle_entity_array 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
+*/