89bf81b4 |
1 | <?php |
2 | /** |
50fb255d |
3 | * @file |
4 | * Test Generated API Example. |
5 | * See bottom of this file for more detail. |
89bf81b4 |
6 | */ |
89bf81b4 |
7 | |
50fb255d |
8 | /** |
9 | * Test Generated example of using activity delete API. |
10 | * |
11 | * |
12 | * @return array |
13 | * API result array |
14 | */ |
15 | function activity_delete_example() { |
16 | $params = array( |
17 | 'id' => 1, |
18 | ); |
89bf81b4 |
19 | |
50fb255d |
20 | try{ |
21 | $result = civicrm_api3('activity', 'delete', $params); |
22 | } |
23 | catch (CiviCRM_API3_Exception $e) { |
24 | // Handle error here. |
25 | $errorMessage = $e->getMessage(); |
26 | $errorCode = $e->getErrorCode(); |
27 | $errorData = $e->getExtraParams(); |
28 | return array( |
29 | 'error' => $errorMessage, |
30 | 'error_code' => $errorCode, |
31 | 'error_data' => $errorData, |
32 | ); |
33 | } |
34 | |
35 | return $result; |
89bf81b4 |
36 | } |
37 | |
38 | /** |
50fb255d |
39 | * Function returns array of result expected from previous function. |
40 | * |
41 | * @return array |
42 | * API result array |
89bf81b4 |
43 | */ |
50fb255d |
44 | function activity_delete_expectedresult() { |
89bf81b4 |
45 | |
46 | $expectedResult = array( |
50fb255d |
47 | 'is_error' => 0, |
48 | 'version' => 3, |
49 | 'count' => 1, |
50 | 'values' => 1, |
51 | ); |
89bf81b4 |
52 | |
53 | return $expectedResult; |
54 | } |
55 | |
50fb255d |
56 | /** |
57 | * This example has been generated from the API test suite. |
58 | * The test that created it is called |
59 | * testDeleteActivity |
60 | * and can be found in |
89bf81b4 |
61 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php |
62 | * |
63 | * You can see the outcome of the API tests at |
64 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
65 | * |
66 | * To Learn about the API read |
67 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
68 | * |
69 | * Browse the api on your own site with the api explorer |
70 | * http://MYSITE.ORG/path/to/civicrm/api/explorer |
71 | * |
72 | * Read more about testing here |
73 | * http://wiki.civicrm.org/confluence/display/CRM/Testing |
74 | * |
75 | * API Standards documentation: |
76 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards |
77 | */ |