api/v3/examples/BatchCreate.php

   1 <?php
   2 /**
   3  * Test Generated example of using batch create API
   4  * *
   5  */
   6 function batch_create_example(){
   7 $params = array(
   8   'name' => 'New_Batch_03',
   9   'title' => 'New Batch 03',
  10   'description' => 'This is description for New Batch 03',
  11   'total' => '300.33',
  12   'item_count' => 3,
  13   'status_id' => 1,
  14 );
  15
  16 try{
  17   $result = civicrm_api3('batch', 'create', $params);
  18 }
  19 catch (CiviCRM_API3_Exception $e) {
  20   // handle error here
  21   $errorMessage = $e->getMessage();
  22   $errorCode = $e->getErrorCode();
  23   $errorData = $e->getExtraParams();
  24   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  25 }
  26
  27 return $result;
  28 }
  29
  30 /**
  31  * Function returns array of result expected from previous function
  32  */
  33 function batch_create_expectedresult(){
  34
  35   $expectedResult = array(
  36   'is_error' => 0,
  37   'version' => 3,
  38   'count' => 1,
  39   'id' => 1,
  40   'values' => array(
  41       '1' => array(
  42           'id' => '1',
  43           'name' => 'New_Batch_03',
  44           'title' => 'New Batch 03',
  45           'description' => 'This is description for New Batch 03',
  46           'created_id' => '',
  47           'created_date' => '2013-07-28 05:52:14',
  48           'modified_id' => '',
  49           'modified_date' => '2012-11-14 16:02:35',
  50           'saved_search_id' => '',
  51           'status_id' => '1',
  52           'type_id' => '',
  53           'mode_id' => '',
  54           'total' => '300.33',
  55           'item_count' => '3',
  56           'payment_instrument_id' => '',
  57           'exported_date' => '',
  58         ),
  59     ),
  60 );
  61
  62   return $expectedResult;
  63 }
  64
  65
  66 /*
  67 * This example has been generated from the API test suite. The test that created it is called
  68 *
  69 * testCreate and can be found in
  70 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/BatchTest.php
  71 *
  72 * You can see the outcome of the API tests at
  73 * http://tests.dev.civicrm.org/trunk/results-api_v3
  74 *
  75 * To Learn about the API read
  76 * http://book.civicrm.org/developer/current/techniques/api/
  77 *
  78 * and review the wiki at
  79 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  80 *
  81 * Read more about testing here
  82 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  83 *
  84 * API Standards documentation:
  85 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  86 */