Commit | Line | Data |
---|---|---|
7f254ad8 AE |
1 | <?php |
2 | /** | |
3 | * Test Generated example demonstrating the Im.get API. | |
4 | * | |
5 | * @return array | |
6 | * API result array | |
7 | */ | |
8 | function im_get_example() { | |
9 | $params = array( | |
10 | 'contact_id' => 4, | |
11 | 'name' => 'My Yahoo IM Handle', | |
12 | 'location_type_id' => 1, | |
13 | 'provider_id' => 1, | |
14 | ); | |
15 | ||
16 | try{ | |
17 | $result = civicrm_api3('Im', 'get', $params); | |
18 | } | |
19 | catch (CiviCRM_API3_Exception $e) { | |
20 | // Handle error here. | |
21 | $errorMessage = $e->getMessage(); | |
22 | $errorCode = $e->getErrorCode(); | |
23 | $errorData = $e->getExtraParams(); | |
24 | return array( | |
25 | 'error' => $errorMessage, | |
26 | 'error_code' => $errorCode, | |
27 | 'error_data' => $errorData, | |
28 | ); | |
29 | } | |
30 | ||
31 | return $result; | |
32 | } | |
33 | ||
34 | /** | |
35 | * Function returns array of result expected from previous function. | |
36 | * | |
37 | * @return array | |
38 | * API result array | |
39 | */ | |
40 | function im_get_expectedresult() { | |
41 | ||
42 | $expectedResult = array( | |
43 | 'is_error' => 0, | |
44 | 'version' => 3, | |
45 | 'count' => 1, | |
46 | 'id' => 2, | |
47 | 'values' => array( | |
48 | '2' => array( | |
49 | 'id' => '2', | |
50 | 'contact_id' => '4', | |
51 | 'location_type_id' => '1', | |
52 | 'name' => 'My Yahoo IM Handle', | |
53 | 'provider_id' => '1', | |
54 | 'is_primary' => 0, | |
55 | 'is_billing' => 0, | |
56 | ), | |
57 | ), | |
58 | ); | |
59 | ||
60 | return $expectedResult; | |
61 | } | |
62 | ||
63 | /* | |
64 | * This example has been generated from the API test suite. | |
65 | * The test that created it is called "testGetIm" | |
66 | * and can be found at: | |
67 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ImTest.php | |
68 | * | |
69 | * You can see the outcome of the API tests at | |
70 | * https://test.civicrm.org/job/CiviCRM-master-git/ | |
71 | * | |
72 | * To Learn about the API read | |
73 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API | |
74 | * | |
75 | * Browse the api on your own site with the api explorer | |
76 | * http://MYSITE.ORG/path/to/civicrm/api | |
77 | * | |
78 | * Read more about testing here | |
79 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
80 | * | |
81 | * API Standards documentation: | |
82 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
83 | */ |