Commit | Line | Data |
---|---|---|
397e0e51 EC |
1 | <?php |
2 | /** | |
0a972ab7 | 3 | * Test Generated example of using message_template delete API |
397e0e51 EC |
4 | * * |
5 | */ | |
0a972ab7 | 6 | function message_template_delete_example(){ |
397e0e51 EC |
7 | $params = array( |
8 | 'id' => 2, | |
9 | ); | |
10 | ||
11 | try{ | |
0a972ab7 | 12 | $result = civicrm_api3('message_template', 'delete', $params); |
397e0e51 EC |
13 | } |
14 | catch (CiviCRM_API3_Exception $e) { | |
15 | // handle error here | |
16 | $errorMessage = $e->getMessage(); | |
17 | $errorCode = $e->getErrorCode(); | |
18 | $errorData = $e->getExtraParams(); | |
19 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
20 | } | |
21 | ||
22 | return $result; | |
23 | } | |
24 | ||
25 | /** | |
26 | * Function returns array of result expected from previous function | |
27 | */ | |
0a972ab7 | 28 | function message_template_delete_expectedresult(){ |
397e0e51 EC |
29 | |
30 | $expectedResult = array( | |
31 | 'is_error' => 0, | |
32 | 'version' => 3, | |
33 | 'count' => 1, | |
34 | 'values' => true, | |
35 | ); | |
36 | ||
37 | return $expectedResult; | |
38 | } | |
39 | ||
40 | ||
41 | /* | |
42 | * This example has been generated from the API test suite. The test that created it is called | |
43 | * | |
44 | * testDelete and can be found in | |
69d79249 | 45 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MessageTemplateTest.php |
397e0e51 EC |
46 | * |
47 | * You can see the outcome of the API tests at | |
69d79249 | 48 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
397e0e51 EC |
49 | * |
50 | * To Learn about the API read | |
69d79249 | 51 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
397e0e51 | 52 | * |
69d79249 E |
53 | * Browse the api on your own site with the api explorer |
54 | * http://MYSITE.ORG/path/to/civicrm/api/explorer | |
397e0e51 EC |
55 | * |
56 | * Read more about testing here | |
57 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
58 | * | |
59 | * API Standards documentation: | |
60 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 61 | */ |