api/v3/examples/Job/Create.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Job.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function job_create_example() {
   9   $params = array(
  10     'sequential' => 1,
  11     'name' => 'API_Test_Job',
  12     'description' => 'A long description written by hand in cursive',
  13     'run_frequency' => 'Daily',
  14     'api_entity' => 'ApiTestEntity',
  15     'api_action' => 'apitestaction',
  16     'parameters' => 'Semi-formal explanation of runtime job parameters',
  17     'is_active' => 1,
  18   );
  19
  20   try{
  21     $result = civicrm_api3('Job', 'create', $params);
  22   }
  23   catch (CiviCRM_API3_Exception $e) {
  24     // Handle error here.
  25     $errorMessage = $e->getMessage();
  26     $errorCode = $e->getErrorCode();
  27     $errorData = $e->getExtraParams();
  28     return array(
  29       'error' => $errorMessage,
  30       'error_code' => $errorCode,
  31       'error_data' => $errorData,
  32     );
  33   }
  34
  35   return $result;
  36 }
  37
  38 /**
  39  * Function returns array of result expected from previous function.
  40  *
  41  * @return array
  42  *   API result array
  43  */
  44 function job_create_expectedresult() {
  45
  46   $expectedResult = array(
  47     'is_error' => 0,
  48     'version' => 3,
  49     'count' => 1,
  50     'id' => 29,
  51     'values' => array(
  52       '0' => array(
  53         'id' => '29',
  54         'domain_id' => '1',
  55         'run_frequency' => 'Daily',
  56         'last_run' => '',
  57         'name' => 'API_Test_Job',
  58         'description' => 'A long description written by hand in cursive',
  59         'api_entity' => 'ApiTestEntity',
  60         'api_action' => 'apitestaction',
  61         'parameters' => 'Semi-formal explanation of runtime job parameters',
  62         'is_active' => '1',
  63       ),
  64     ),
  65   );
  66
  67   return $expectedResult;
  68 }
  69
  70 /*
  71 * This example has been generated from the API test suite.
  72 * The test that created it is called "testCreate"
  73 * and can be found at:
  74 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/JobTest.php
  75 *
  76 * You can see the outcome of the API tests at
  77 * https://test.civicrm.org/job/CiviCRM-master-git/
  78 *
  79 * To Learn about the API read
  80 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  81 *
  82 * Browse the api on your own site with the api explorer
  83 * http://MYSITE.ORG/path/to/civicrm/api
  84 *
  85 * Read more about testing here
  86 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  87 *
  88 * API Standards documentation:
  89 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  90 */