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