Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using activity get API | |
4 | * * | |
6a488035 TO |
5 | */ |
6 | function activity_get_example(){ | |
feb2a730 | 7 | $params = array( |
9f1b81e0 | 8 | 'contact_id' => 1, |
edb0d67a | 9 | 'activity_type_id' => '46', |
6a488035 TO |
10 | 'sequential' => 1, |
11 | 'return.custom_1' => 1, | |
12 | ); | |
13 | ||
fb32de45 | 14 | try{ |
15 | $result = civicrm_api3('activity', 'get', $params); | |
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('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
23 | } | |
6a488035 | 24 | |
fb32de45 | 25 | return $result; |
6a488035 TO |
26 | } |
27 | ||
fb32de45 | 28 | /** |
6a488035 TO |
29 | * Function returns array of result expected from previous function |
30 | */ | |
31 | function activity_get_expectedresult(){ | |
32 | ||
feb2a730 | 33 | $expectedResult = array( |
6a488035 TO |
34 | 'is_error' => 0, |
35 | 'version' => 3, | |
36 | 'count' => 1, | |
37 | 'id' => 1, | |
feb2a730 | 38 | 'values' => array( |
39 | '0' => array( | |
9f1b81e0 | 40 | 'source_contact_id' => '1', |
6a488035 | 41 | 'id' => '1', |
edb0d67a | 42 | 'activity_type_id' => '46', |
6a488035 TO |
43 | 'subject' => 'test activity type id', |
44 | 'location' => 'Pensulvania', | |
45 | 'activity_date_time' => '2011-06-02 14:36:13', | |
46 | 'details' => 'a test activity', | |
47 | 'status_id' => '2', | |
48 | 'activity_name' => 'Test activity type', | |
49 | 'status' => 'Completed', | |
50 | 'custom_1' => 'custom string', | |
51 | 'custom_1_1' => 'custom string', | |
52 | ), | |
53 | ), | |
54 | ); | |
55 | ||
fb32de45 | 56 | return $expectedResult; |
6a488035 TO |
57 | } |
58 | ||
59 | ||
60 | /* | |
61 | * This example has been generated from the API test suite. The test that created it is called | |
62 | * | |
63 | * testActivityGetContact_idCustom and can be found in | |
69d79249 | 64 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php |
6a488035 TO |
65 | * |
66 | * You can see the outcome of the API tests at | |
69d79249 | 67 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
68 | * |
69 | * To Learn about the API read | |
69d79249 | 70 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 71 | * |
69d79249 E |
72 | * Browse the api on your own site with the api explorer |
73 | * http://MYSITE.ORG/path/to/civicrm/api/explorer | |
6a488035 TO |
74 | * |
75 | * Read more about testing here | |
76 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
77 | * | |
78 | * API Standards documentation: | |
79 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 80 | */ |