Merge branch 'rcsheets-docstring-cleanup'

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

diff --git a/api/v3/examples/Contact/GroupFilterUsingContactAPI.php b/api/v3/examples/Contact/GroupFilterUsingContactAPI.php
index 6e11f1bfb6034247924ed18791a3cf3f34d8521f..da32f8f530601adc328ca2bf261e69081acac24d 100644 (file)
--- a/api/v3/examples/Contact/GroupFilterUsingContactAPI.php
+++ b/api/v3/examples/Contact/GroupFilterUsingContactAPI.php
@@ -1,7 +1,7 @@
 <?php
-
-/*
- Get all from group and display contacts
+/**
+ * Test Generated example of using contact get API
+ * Get all from group and display contacts *
  */
 function contact_get_example(){
 $params = array(
@@ -9,16 +9,24 @@ $params = array(
       '0' => 1,
       '1' => 26,
     ),
-  'version' => 3,
   'contact_type' => 'Individual',
 );
 
-  $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(){
@@ -46,11 +54,16 @@ function contact_get_expectedresult(){
           'nick_name' => '',
           'legal_name' => '',
           'image_URL' => '',
+          'preferred_communication_method' => '',
+          'preferred_language' => 'en_US',
           'preferred_mail_format' => 'Both',
           'first_name' => '',
           'middle_name' => '',
           'last_name' => '',
+          'prefix_id' => '',
+          'suffix_id' => '',
           'job_title' => '',
+          'gender_id' => '',
           'birth_date' => '',
           'is_deceased' => 0,
           'deceased_date' => '',
@@ -59,8 +72,8 @@ function contact_get_expectedresult(){
           'sic_code' => '',
           'contact_is_deleted' => 0,
           'current_employer' => '',
-          'address_id' => '',
-          'street_address' => '',
+          'address_id' => '2',
+          'street_address' => '1 my road',
           'supplemental_address_1' => '',
           'supplemental_address_2' => '',
           'city' => '',
@@ -69,10 +82,7 @@ function contact_get_expectedresult(){
           'geo_code_1' => '',
           'geo_code_2' => '',
           'state_province_id' => '',
-          'state_province_name' => '',
-          'state_province' => '',
           'country_id' => '',
-          'country' => '',
           'phone_id' => '',
           'phone_type_id' => '',
           'phone' => '',
@@ -84,12 +94,18 @@ function contact_get_expectedresult(){
           'im' => '',
           'worldregion_id' => '',
           'world_region' => '',
+          'individual_prefix' => '',
+          'individual_suffix' => '',
+          'gender' => '',
+          'state_province_name' => '',
+          'state_province' => '',
+          'country' => '',
           'id' => '1',
         ),
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -97,20 +113,20 @@ function contact_get_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testGetGroupIDFromContact 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
+*/