Commit | Line | Data |
---|---|---|
89bf81b4 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Mailing.delete API. |
50fb255d | 4 | * |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function mailing_delete_example() { | |
9 | $params = array( | |
a828d7b8 | 10 | 'id' => 18, |
50fb255d | 11 | ); |
89bf81b4 | 12 | |
50fb255d | 13 | try{ |
a828d7b8 | 14 | $result = civicrm_api3('Mailing', 'delete', $params); |
50fb255d | 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( | |
5be22f39 | 22 | 'is_error' => 1, |
23 | 'error_message' => $errorMessage, | |
50fb255d | 24 | 'error_code' => $errorCode, |
25 | 'error_data' => $errorData, | |
26 | ); | |
27 | } | |
28 | ||
29 | return $result; | |
89bf81b4 | 30 | } |
31 | ||
32 | /** | |
50fb255d | 33 | * Function returns array of result expected from previous function. |
34 | * | |
35 | * @return array | |
36 | * API result array | |
89bf81b4 | 37 | */ |
50fb255d | 38 | function mailing_delete_expectedresult() { |
89bf81b4 | 39 | |
40 | $expectedResult = array( | |
50fb255d | 41 | 'is_error' => 0, |
42 | 'version' => 3, | |
43 | 'count' => 1, | |
5be22f39 | 44 | 'values' => 1, |
50fb255d | 45 | ); |
89bf81b4 | 46 | |
47 | return $expectedResult; | |
48 | } | |
49 | ||
a828d7b8 | 50 | /* |
50fb255d | 51 | * This example has been generated from the API test suite. |
a828d7b8 CW |
52 | * The test that created it is called "testMailerDeleteSuccess" |
53 | * and can be found at: | |
89bf81b4 | 54 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingTest.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 | |
41d4d31f | 63 | * http://MYSITE.ORG/path/to/civicrm/api |
89bf81b4 | 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 | */ |