Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Job.delete API. |
50fb255d | 4 | * |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function job_delete_example() { | |
cf8f0fff | 9 | $params = [ |
8390b11b | 10 | 'id' => 33, |
cf8f0fff | 11 | ]; |
6a488035 | 12 | |
50fb255d | 13 | try{ |
a828d7b8 | 14 | $result = civicrm_api3('Job', '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(); | |
cf8f0fff | 21 | return [ |
5be22f39 | 22 | 'is_error' => 1, |
23 | 'error_message' => $errorMessage, | |
50fb255d | 24 | 'error_code' => $errorCode, |
25 | 'error_data' => $errorData, | |
cf8f0fff | 26 | ]; |
50fb255d | 27 | } |
28 | ||
29 | return $result; | |
6a488035 TO |
30 | } |
31 | ||
fb32de45 | 32 | /** |
50fb255d | 33 | * Function returns array of result expected from previous function. |
34 | * | |
35 | * @return array | |
36 | * API result array | |
6a488035 | 37 | */ |
50fb255d | 38 | function job_delete_expectedresult() { |
6a488035 | 39 | |
89bf81b4 | 40 | $expectedResult = ''; |
6a488035 | 41 | |
fb32de45 | 42 | return $expectedResult; |
6a488035 TO |
43 | } |
44 | ||
a828d7b8 | 45 | /* |
50fb255d | 46 | * This example has been generated from the API test suite. |
a828d7b8 CW |
47 | * The test that created it is called "testDelete" |
48 | * and can be found at: | |
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 | |
8390b11b | 52 | * https://test.civicrm.org/job/CiviCRM-Core-Matrix/ |
6a488035 TO |
53 | * |
54 | * To Learn about the API read | |
8390b11b | 55 | * https://docs.civicrm.org/dev/en/latest/api/ |
6a488035 | 56 | * |
8390b11b SL |
57 | * Browse the API on your own site with the API Explorer. It is in the main |
58 | * CiviCRM menu, under: Support > Development > API Explorer. | |
6a488035 TO |
59 | * |
60 | * Read more about testing here | |
8390b11b | 61 | * https://docs.civicrm.org/dev/en/latest/testing/ |
6a488035 TO |
62 | * |
63 | * API Standards documentation: | |
8390b11b | 64 | * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/ |
49f8272d | 65 | */ |