Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Contact.get API. |
50fb255d | 4 | * |
fb32de45 | 5 | * This demonstrates use of the 'format.is_success' param. |
5c49fee0 | 6 | * This param causes only the success or otherwise of the function to be returned as BOOLEAN |
50fb255d | 7 | * |
8 | * @return array | |
9 | * API result array | |
6a488035 | 10 | */ |
50fb255d | 11 | function contact_get_example() { |
cf8f0fff | 12 | $params = [ |
50fb255d | 13 | 'id' => 17, |
14 | 'format.is_success' => 1, | |
cf8f0fff | 15 | ]; |
6a488035 | 16 | |
50fb255d | 17 | try{ |
a828d7b8 | 18 | $result = civicrm_api3('Contact', 'get', $params); |
50fb255d | 19 | } |
20 | catch (CiviCRM_API3_Exception $e) { | |
21 | // Handle error here. | |
22 | $errorMessage = $e->getMessage(); | |
23 | $errorCode = $e->getErrorCode(); | |
24 | $errorData = $e->getExtraParams(); | |
cf8f0fff | 25 | return [ |
5be22f39 | 26 | 'is_error' => 1, |
27 | 'error_message' => $errorMessage, | |
50fb255d | 28 | 'error_code' => $errorCode, |
29 | 'error_data' => $errorData, | |
cf8f0fff | 30 | ]; |
50fb255d | 31 | } |
6a488035 | 32 | |
50fb255d | 33 | return $result; |
6a488035 TO |
34 | } |
35 | ||
fb32de45 | 36 | /** |
50fb255d | 37 | * Function returns array of result expected from previous function. |
38 | * | |
39 | * @return array | |
40 | * API result array | |
6a488035 | 41 | */ |
50fb255d | 42 | function contact_get_expectedresult() { |
6a488035 TO |
43 | |
44 | $expectedResult = 1; | |
45 | ||
fb32de45 | 46 | return $expectedResult; |
6a488035 TO |
47 | } |
48 | ||
a828d7b8 | 49 | /* |
50fb255d | 50 | * This example has been generated from the API test suite. |
a828d7b8 CW |
51 | * The test that created it is called "testContactGetFormatIsSuccessTrue" |
52 | * and can be found at: | |
69d79249 | 53 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php |
6a488035 TO |
54 | * |
55 | * You can see the outcome of the API tests at | |
69d79249 | 56 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
57 | * |
58 | * To Learn about the API read | |
69d79249 | 59 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 60 | * |
69d79249 | 61 | * Browse the api on your own site with the api explorer |
41d4d31f | 62 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
63 | * |
64 | * Read more about testing here | |
65 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
66 | * | |
67 | * API Standards documentation: | |
68 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 69 | */ |