Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using im get API | |
4 | * * | |
6a488035 TO |
5 | */ |
6 | function im_get_example(){ | |
53ca8fd7 | 7 | $params = array( |
6a488035 TO |
8 | 'contact_id' => 1, |
9 | 'name' => 'My Yahoo IM Handle', | |
10 | 'location_type_id' => 1, | |
11 | 'provider_id' => 1, | |
12 | ); | |
13 | ||
fb32de45 | 14 | try{ |
15 | $result = civicrm_api3('im', 'get', $params); | |
16 | } | |
17 | catch (CiviCRM_API3_Exception $e) { | |
18 | // handle error here | |
19 | $errorMessage = $e->getMessage(); | |
20 | $errorCode = $e->getErrorCode(); | |
21 | $errorData = $e->getExtraParams(); | |
22 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
23 | } | |
6a488035 | 24 | |
fb32de45 | 25 | return $result; |
6a488035 TO |
26 | } |
27 | ||
fb32de45 | 28 | /** |
6a488035 TO |
29 | * Function returns array of result expected from previous function |
30 | */ | |
31 | function im_get_expectedresult(){ | |
32 | ||
53ca8fd7 | 33 | $expectedResult = array( |
6a488035 TO |
34 | 'is_error' => 0, |
35 | 'version' => 3, | |
36 | 'count' => 1, | |
37 | 'id' => 1, | |
53ca8fd7 | 38 | 'values' => array( |
39 | '1' => array( | |
6a488035 TO |
40 | 'id' => '1', |
41 | 'contact_id' => '1', | |
42 | 'location_type_id' => '1', | |
43 | 'name' => 'My Yahoo IM Handle', | |
44 | 'provider_id' => '1', | |
45 | 'is_primary' => 0, | |
46 | 'is_billing' => 0, | |
47 | ), | |
48 | ), | |
49 | ); | |
50 | ||
fb32de45 | 51 | return $expectedResult; |
6a488035 TO |
52 | } |
53 | ||
54 | ||
55 | /* | |
56 | * This example has been generated from the API test suite. The test that created it is called | |
57 | * | |
58 | * testGetIm and can be found in | |
59 | * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ImTest.php | |
60 | * | |
61 | * You can see the outcome of the API tests at | |
62 | * http://tests.dev.civicrm.org/trunk/results-api_v3 | |
63 | * | |
64 | * To Learn about the API read | |
65 | * http://book.civicrm.org/developer/current/techniques/api/ | |
66 | * | |
67 | * and review the wiki at | |
68 | * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs | |
69 | * | |
70 | * Read more about testing here | |
71 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
72 | * | |
73 | * API Standards documentation: | |
74 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 75 | */ |