Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Phone.get API. |
50fb255d | 4 | * |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function phone_get_example() { | |
9 | $params = array( | |
10 | 'contact_id' => 7, | |
11 | 'phone' => '(123) 456-7890', | |
12 | ); | |
6a488035 | 13 | |
50fb255d | 14 | try{ |
a828d7b8 | 15 | $result = civicrm_api3('Phone', 'get', $params); |
50fb255d | 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( | |
1d8ee3d6 | 23 | 'is_error' => 1, |
24 | 'error_message' => $errorMessage, | |
50fb255d | 25 | 'error_code' => $errorCode, |
26 | 'error_data' => $errorData, | |
27 | ); | |
28 | } | |
29 | ||
30 | return $result; | |
6a488035 TO |
31 | } |
32 | ||
fb32de45 | 33 | /** |
50fb255d | 34 | * Function returns array of result expected from previous function. |
35 | * | |
36 | * @return array | |
37 | * API result array | |
6a488035 | 38 | */ |
50fb255d | 39 | function phone_get_expectedresult() { |
6a488035 | 40 | |
53ca8fd7 | 41 | $expectedResult = array( |
50fb255d | 42 | 'is_error' => 0, |
43 | 'version' => 3, | |
44 | 'count' => 1, | |
45 | 'id' => 4, | |
46 | 'values' => array( | |
47 | '4' => array( | |
48 | 'id' => '4', | |
49 | 'contact_id' => '7', | |
50 | 'location_type_id' => '10', | |
51 | 'is_primary' => '1', | |
52 | 'is_billing' => 0, | |
53 | 'phone' => '(123) 456-7890', | |
54 | 'phone_numeric' => '1234567890', | |
55 | 'phone_type_id' => '1', | |
56 | ), | |
6a488035 | 57 | ), |
50fb255d | 58 | ); |
6a488035 | 59 | |
fb32de45 | 60 | return $expectedResult; |
6a488035 TO |
61 | } |
62 | ||
a828d7b8 | 63 | /* |
50fb255d | 64 | * This example has been generated from the API test suite. |
a828d7b8 CW |
65 | * The test that created it is called "testGet" |
66 | * and can be found at: | |
69d79249 | 67 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PhoneTest.php |
6a488035 TO |
68 | * |
69 | * You can see the outcome of the API tests at | |
69d79249 | 70 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
71 | * |
72 | * To Learn about the API read | |
69d79249 | 73 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 74 | * |
69d79249 | 75 | * Browse the api on your own site with the api explorer |
41d4d31f | 76 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
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 | |
b259a4ab | 83 | */ |