api/v3/examples/Job/Delete.php

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