api/v3/examples/Job/Delete.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 = array(
  10     'id' => 30,
  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 array(
  22       'error' => $errorMessage,
  23       'error_code' => $errorCode,
  24       'error_data' => $errorData,
  25     );
  26   }
  27
  28   return $result;
  29 }
  30
  31 /**
  32  * Function returns array of result expected from previous function.
  33  *
  34  * @return array
  35  *   API result array
  36  */
  37 function job_delete_expectedresult() {
  38
  39   $expectedResult = '';
  40
  41   return $expectedResult;
  42 }
  43
  44 /*
  45 * This example has been generated from the API test suite.
  46 * The test that created it is called "testDelete"
  47 * and can be found at:
  48 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/JobTest.php
  49 *
  50 * You can see the outcome of the API tests at
  51 * https://test.civicrm.org/job/CiviCRM-master-git/
  52 *
  53 * To Learn about the API read
  54 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  55 *
  56 * Browse the api on your own site with the api explorer
  57 * http://MYSITE.ORG/path/to/civicrm/api
  58 *
  59 * Read more about testing here
  60 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  61 *
  62 * API Standards documentation:
  63 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  64 */