Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using activity get API | |
4 | * demonstrates _low filter (at time of writing doesn't work if contact_id is set * | |
6a488035 TO |
5 | */ |
6 | function activity_get_example(){ | |
feb2a730 | 7 | $params = array( |
6a488035 TO |
8 | 'filter.activity_date_time_low' => '20120101000000', |
9 | 'sequential' => 1, | |
10 | ); | |
11 | ||
fb32de45 | 12 | try{ |
13 | $result = civicrm_api3('activity', '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 activity_get_expectedresult(){ | |
30 | ||
feb2a730 | 31 | $expectedResult = array( |
6a488035 TO |
32 | 'is_error' => 0, |
33 | 'version' => 3, | |
34 | 'count' => 1, | |
35 | 'id' => 2, | |
feb2a730 | 36 | 'values' => array( |
37 | '0' => array( | |
6a488035 | 38 | 'id' => '2', |
edb0d67a | 39 | 'activity_type_id' => '46', |
6a488035 TO |
40 | 'subject' => 'Make-it-Happen Meeting', |
41 | 'activity_date_time' => '2012-02-16 00:00:00', | |
42 | 'duration' => '120', | |
43 | 'location' => 'Pensulvania', | |
44 | 'details' => 'a test activity', | |
45 | 'status_id' => '1', | |
46 | 'priority_id' => '1', | |
47 | 'is_test' => 0, | |
48 | 'is_auto' => 0, | |
49 | 'is_current_revision' => '1', | |
50 | 'is_deleted' => 0, | |
9f1b81e0 | 51 | 'source_contact_id' => '1', |
6a488035 TO |
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 | * testGetFilterMaxDate 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 | */ |