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