api/v3/examples/Batch/Get.php

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