1d8ee3d6 |
1 | <?php |
2 | /** |
3 | * Test Generated example demonstrating the StatusPreference.delete API. |
4 | * |
5 | * @return array |
6 | * API result array |
7 | */ |
8 | function status_preference_delete_example() { |
9 | $params = array( |
10 | 'id' => 2, |
11 | ); |
12 | |
13 | try{ |
14 | $result = civicrm_api3('StatusPreference', 'delete', $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( |
22 | 'is_error' => 1, |
23 | 'error_message' => $errorMessage, |
24 | 'error_code' => $errorCode, |
25 | 'error_data' => $errorData, |
26 | ); |
27 | } |
28 | |
29 | return $result; |
30 | } |
31 | |
32 | /** |
33 | * Function returns array of result expected from previous function. |
34 | * |
35 | * @return array |
36 | * API result array |
37 | */ |
38 | function status_preference_delete_expectedresult() { |
39 | |
40 | $expectedResult = array( |
41 | 'is_error' => 0, |
42 | 'version' => 3, |
43 | 'count' => 1, |
44 | 'values' => 1, |
45 | ); |
46 | |
47 | return $expectedResult; |
48 | } |
49 | |
50 | /* |
51 | * This example has been generated from the API test suite. |
52 | * The test that created it is called "testDeleteStatusPreference" |
53 | * and can be found at: |
54 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/StatusPreferenceTest.php |
55 | * |
56 | * You can see the outcome of the API tests at |
57 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
58 | * |
59 | * To Learn about the API read |
60 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
61 | * |
62 | * Browse the api on your own site with the api explorer |
63 | * http://MYSITE.ORG/path/to/civicrm/api |
64 | * |
65 | * Read more about testing here |
66 | * http://wiki.civicrm.org/confluence/display/CRM/Testing |
67 | * |
68 | * API Standards documentation: |
69 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards |
70 | */ |