api/v3/examples/Job/Delete.ex.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Job.delete API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function job_delete_example() {
   9   $params = [
  10     'id' => 33,
  11   ];
  12
  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 [
  22       'is_error' => 1,
  23       'error_message' => $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 "testDelete"
  48 * and can be found at:
  49 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/JobTest.php
  50 *
  51 * You can see the outcome of the API tests at
  52 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
  53 *
  54 * To Learn about the API read
  55 * https://docs.civicrm.org/dev/en/latest/api/
  56 *
  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.
  59 *
  60 * Read more about testing here
  61 * https://docs.civicrm.org/dev/en/latest/testing/
  62 *
  63 * API Standards documentation:
  64 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
  65 */