Merge pull request #2540 from eileenmcnaughton/CRM-14235

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

diff --git a/api/v3/examples/Contact/APIChainedArrayMultipleCustom.php b/api/v3/examples/Contact/APIChainedArrayMultipleCustom.php
index 320c448a732d747e45abbcda61ee968d35c48407..0f1f7985270529eada03a186f89fe58e2ff872b8 100644 (file)
--- a/api/v3/examples/Contact/APIChainedArrayMultipleCustom.php
+++ b/api/v3/examples/Contact/APIChainedArrayMultipleCustom.php
@@ -1,12 +1,11 @@
 <?php
-
-/*
- /*this demonstrates the usage of chained api functions. A variety of techniques are used
+/**
+ * Test Generated example of using contact get API
+ * /*this demonstrates the usage of chained api functions. A variety of techniques are used *
  */
 function contact_get_example(){
 $params = array(
   'id' => 1,
-  'version' => 3,
   'api.website.getValue' => array(
       'return' => 'url',
     ),
@@ -14,12 +13,21 @@ $params = array(
   'api.CustomValue.get' => 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(){
@@ -47,11 +55,16 @@ function contact_get_expectedresult(){
           'nick_name' => '',
           'legal_name' => '',
           'image_URL' => '',
+          'preferred_communication_method' => '',
+          'preferred_language' => 'en_US',
           'preferred_mail_format' => 'Both',
           'first_name' => 'abc3',
           'middle_name' => '',
           'last_name' => 'xyz3',
+          'prefix_id' => '',
+          'suffix_id' => '',
           'job_title' => '',
+          'gender_id' => '',
           'birth_date' => '',
           'is_deceased' => 0,
           'deceased_date' => '',
@@ -60,8 +73,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' => '',
@@ -70,10 +83,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' => '',
@@ -85,19 +95,25 @@ function contact_get_expectedresult(){
           'im' => '',
           'worldregion_id' => '',
           'world_region' => '',
+          'individual_prefix' => '',
+          'individual_suffix' => '',
+          'gender' => '',
+          'state_province_name' => '',
+          'state_province' => '',
+          'country' => '',
           'id' => '1',
           'api.website.getValue' => 'http://civicrm.org',
           'api.Contribution.getCount' => 2,
           'api.CustomValue.get' => array(
               'is_error' => 0,
               'version' => 3,
-              'count' => 10,
+              'count' => 8,
               'values' => array(
                   '0' => array(
                       'entity_id' => '1',
                       'latest' => 'value 4',
-                      'id' => '13',
-                      '0' => 'value 4',
+                      'id' => '1',
+                      'entity_table' => 'Contact',
                     ),
                   '1' => array(
                       'entity_table' => 'Contact',
@@ -105,46 +121,41 @@ function contact_get_expectedresult(){
                   '2' => array(
                       'entity_id' => '1',
                       'latest' => 'value 3',
-                      'id' => '14',
+                      'id' => '2',
                       '1' => 'value 2',
+                      'entity_table' => 'Contact',
                       '2' => 'value 3',
                     ),
                   '3' => array(
-                      'entity_table' => 'Contact',
-                    ),
-                  '4' => array(
                       'entity_id' => '1',
                       'latest' => '',
-                      'id' => '15',
+                      'id' => '3',
                       '1' => 'warm beer',
                       '2' => '',
                     ),
-                  '5' => array(
+                  '4' => array(
                       'entity_id' => '1',
                       'latest' => '',
-                      'id' => '16',
+                      'id' => '4',
                       '1' => '',
                       '2' => '',
                     ),
-                  '6' => array(
-                      'entity_table' => 'Contact',
-                    ),
-                  '7' => array(
+                  '5' => array(
                       'entity_id' => '1',
-                      'latest' => '',
-                      'id' => '17',
-                      '1' => '',
+                      'latest' => 'defaultValue',
+                      'id' => '5',
+                      '1' => 'defaultValue',
                     ),
-                  '8' => array(
+                  '6' => array(
                       'entity_id' => '1',
                       'latest' => 'vegemite',
-                      'id' => '18',
+                      'id' => '6',
                       '1' => 'vegemite',
                     ),
-                  '9' => array(
+                  '7' => array(
                       'entity_id' => '1',
                       'latest' => '',
-                      'id' => '19',
+                      'id' => '7',
                       '1' => '',
                     ),
                 ),
@@ -153,7 +164,7 @@ function contact_get_expectedresult(){
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -161,20 +172,20 @@ function contact_get_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testGetIndividualWithChainedArraysAndMultipleCustom 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
+*/