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() { |
12 | $params = array( | |
13 | 'id' => 17, | |
14 | 'format.is_success' => 1, | |
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(); | |
25 | return array( | |
26 | 'error' => $errorMessage, | |
27 | 'error_code' => $errorCode, | |
28 | 'error_data' => $errorData, | |
29 | ); | |
30 | } | |
6a488035 | 31 | |
50fb255d | 32 | return $result; |
6a488035 TO |
33 | } |
34 | ||
fb32de45 | 35 | /** |
50fb255d | 36 | * Function returns array of result expected from previous function. |
37 | * | |
38 | * @return array | |
39 | * API result array | |
6a488035 | 40 | */ |
50fb255d | 41 | function contact_get_expectedresult() { |
6a488035 TO |
42 | |
43 | $expectedResult = 1; | |
44 | ||
fb32de45 | 45 | return $expectedResult; |
6a488035 TO |
46 | } |
47 | ||
a828d7b8 | 48 | /* |
50fb255d | 49 | * This example has been generated from the API test suite. |
a828d7b8 CW |
50 | * The test that created it is called "testContactGetFormatIsSuccessTrue" |
51 | * and can be found at: | |
69d79249 | 52 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php |
6a488035 TO |
53 | * |
54 | * You can see the outcome of the API tests at | |
69d79249 | 55 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
56 | * |
57 | * To Learn about the API read | |
69d79249 | 58 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 59 | * |
69d79249 | 60 | * Browse the api on your own site with the api explorer |
41d4d31f | 61 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
62 | * |
63 | * Read more about testing here | |
64 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
65 | * | |
66 | * API Standards documentation: | |
67 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 68 | */ |