CRM-19958 Fix invalid name of variable subtype
[civicrm-core.git] / api / v3 / examples / Job / Delete.php
CommitLineData
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 */
8function job_delete_example() {
9 $params = array(
10 'id' => 30,
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();
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;
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 38function 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
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*/