Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using email delete API | |
4 | * * | |
6a488035 TO |
5 | */ |
6 | function email_delete_example(){ | |
53ca8fd7 | 7 | $params = array( |
fb32de45 | 8 | 'id' => 11, |
6a488035 TO |
9 | ); |
10 | ||
fb32de45 | 11 | try{ |
12 | $result = civicrm_api3('email', 'delete', $params); | |
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 | } | |
6a488035 | 21 | |
fb32de45 | 22 | return $result; |
6a488035 TO |
23 | } |
24 | ||
fb32de45 | 25 | /** |
6a488035 TO |
26 | * Function returns array of result expected from previous function |
27 | */ | |
28 | function email_delete_expectedresult(){ | |
29 | ||
53ca8fd7 | 30 | $expectedResult = array( |
6a488035 TO |
31 | 'is_error' => 0, |
32 | 'version' => 3, | |
33 | 'count' => 1, | |
53ca8fd7 | 34 | 'values' => true, |
6a488035 TO |
35 | ); |
36 | ||
fb32de45 | 37 | return $expectedResult; |
6a488035 TO |
38 | } |
39 | ||
40 | ||
41 | /* | |
42 | * This example has been generated from the API test suite. The test that created it is called | |
43 | * | |
44 | * testDeleteEmail and can be found in | |
45 | * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/EmailTest.php | |
46 | * | |
47 | * You can see the outcome of the API tests at | |
48 | * http://tests.dev.civicrm.org/trunk/results-api_v3 | |
49 | * | |
50 | * To Learn about the API read | |
51 | * http://book.civicrm.org/developer/current/techniques/api/ | |
52 | * | |
53 | * and review the wiki at | |
54 | * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs | |
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 | |
61 | */ |