Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using contact get API | |
4 | * This demonstrates use of the 'format.is_success' param. | |
5 | This param causes only the success or otherwise of the function to be returned as BOOLEAN * | |
6a488035 TO |
6 | */ |
7 | function contact_get_example(){ | |
edb0d67a | 8 | $params = array( |
6a488035 TO |
9 | 'id' => 17, |
10 | 'format.is_success' => 1, | |
11 | ); | |
12 | ||
fb32de45 | 13 | try{ |
14 | $result = civicrm_api3('contact', 'get', $params); | |
15 | } | |
16 | catch (CiviCRM_API3_Exception $e) { | |
17 | // handle error here | |
18 | $errorMessage = $e->getMessage(); | |
19 | $errorCode = $e->getErrorCode(); | |
20 | $errorData = $e->getExtraParams(); | |
21 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
22 | } | |
6a488035 | 23 | |
fb32de45 | 24 | return $result; |
6a488035 TO |
25 | } |
26 | ||
fb32de45 | 27 | /** |
6a488035 TO |
28 | * Function returns array of result expected from previous function |
29 | */ | |
30 | function contact_get_expectedresult(){ | |
31 | ||
32 | $expectedResult = 1; | |
33 | ||
fb32de45 | 34 | return $expectedResult; |
6a488035 TO |
35 | } |
36 | ||
37 | ||
38 | /* | |
39 | * This example has been generated from the API test suite. The test that created it is called | |
40 | * | |
41 | * testContactGetFormatIsSuccessTrue and can be found in | |
42 | * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php | |
43 | * | |
44 | * You can see the outcome of the API tests at | |
45 | * http://tests.dev.civicrm.org/trunk/results-api_v3 | |
46 | * | |
47 | * To Learn about the API read | |
48 | * http://book.civicrm.org/developer/current/techniques/api/ | |
49 | * | |
50 | * and review the wiki at | |
51 | * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs | |
52 | * | |
53 | * Read more about testing here | |
54 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
55 | * | |
56 | * API Standards documentation: | |
57 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
58 | */ |