fix failing test, check contribution creating with default date of now
[civicrm-core.git] / api / v3 / examples / Contact / GetSingleContact.php
CommitLineData
6a488035 1<?php
fb32de45 2/**
3 * Test Generated example of using contact getsingle API
4 * This demonstrates use of the 'format.single_entity_array' param.
6a488035 5 /* This param causes the only contact to be returned as an array without the other levels.
fb32de45 6 /* it will be ignored if there is not exactly 1 result *
6a488035
TO
7 */
8function contact_getsingle_example(){
edb0d67a 9$params = array(
6a488035
TO
10 'id' => 17,
11);
12
fb32de45 13try{
14 $result = civicrm_api3('contact', 'getsingle', $params);
15}
16catch (CiviCRM_API3_Exception $e) {
17 // handle error here
18 $errorMessage = $e->getMessage();
19 $errorCode = $e->getErrorCode();
20 $errorData = $e->getExtraParams();
21 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
22}
6a488035 23
fb32de45 24return $result;
6a488035
TO
25}
26
fb32de45 27/**
6a488035
TO
28 * Function returns array of result expected from previous function
29 */
30function contact_getsingle_expectedresult(){
31
edb0d67a 32 $expectedResult = array(
6a488035
TO
33 'contact_id' => '17',
34 'contact_type' => 'Individual',
35 'contact_sub_type' => '',
36 'sort_name' => '',
37 'display_name' => 'Test Contact',
38 'do_not_email' => '',
39 'do_not_phone' => '',
40 'do_not_mail' => '',
41 'do_not_sms' => '',
42 'do_not_trade' => '',
43 'is_opt_out' => 0,
44 'legal_identifier' => '',
45 'external_identifier' => '',
46 'nick_name' => '',
47 'legal_name' => '',
48 'image_URL' => '',
49 'preferred_mail_format' => '',
50 'first_name' => 'Test',
51 'middle_name' => '',
52 'last_name' => 'Contact',
6ecbca5b 53 'prefix_id' => '',
54 'suffix_id' => '',
6a488035 55 'job_title' => '',
6ecbca5b 56 'gender_id' => '',
6a488035
TO
57 'birth_date' => '',
58 'is_deceased' => 0,
59 'deceased_date' => '',
60 'household_name' => '',
61 'organization_name' => '',
62 'sic_code' => '',
63 'contact_is_deleted' => 0,
6a488035
TO
64 'current_employer' => '',
65 'address_id' => '',
66 'street_address' => '',
67 'supplemental_address_1' => '',
68 'supplemental_address_2' => '',
69 'city' => '',
70 'postal_code_suffix' => '',
71 'postal_code' => '',
72 'geo_code_1' => '',
73 'geo_code_2' => '',
74 'state_province_id' => '',
6a488035 75 'country_id' => '',
6a488035
TO
76 'phone_id' => '',
77 'phone_type_id' => '',
78 'phone' => '',
79 'email_id' => '',
80 'email' => '',
81 'on_hold' => '',
82 'im_id' => '',
83 'provider_id' => '',
84 'im' => '',
85 'worldregion_id' => '',
86 'world_region' => '',
6ecbca5b 87 'individual_prefix' => '',
88 'individual_suffix' => '',
89 'gender' => '',
9f1b81e0 90 'state_province_name' => '',
91 'state_province' => '',
92 'country' => '',
6a488035
TO
93 'id' => '17',
94);
95
fb32de45 96 return $expectedResult;
6a488035
TO
97}
98
99
100/*
101* This example has been generated from the API test suite. The test that created it is called
102*
103* testContactGetSingle_entity_array and can be found in
104* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php
105*
106* You can see the outcome of the API tests at
107* http://tests.dev.civicrm.org/trunk/results-api_v3
108*
109* To Learn about the API read
110* http://book.civicrm.org/developer/current/techniques/api/
111*
112* and review the wiki at
113* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
114*
115* Read more about testing here
116* http://wiki.civicrm.org/confluence/display/CRM/Testing
117*
118* API Standards documentation:
119* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
120*/