api/v3/examples/LineItem/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using line_item get API
   4  * *
   5  */
   6 function line_item_get_example(){
   7 $params = array(
   8   'entity_table' => 'civicrm_contribution',
   9 );
  10
  11 try{
  12   $result = civicrm_api3('line_item', '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 line_item_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           'entity_table' => 'civicrm_contribution',
  39           'entity_id' => '1',
  40           'contribution_id' => '1',
  41           'price_field_id' => '1',
  42           'label' => 'Contribution Amount',
  43           'qty' => '1',
  44           'unit_price' => '100.00',
  45           'line_total' => '100.00',
  46           'price_field_value_id' => '1',
  47           'financial_type_id' => '1',
  48           'deductible_amount' => '0.00',
  49         ),
  50     ),
  51 );
  52
  53   return $expectedResult;
  54 }
  55
  56
  57 /*
  58 * This example has been generated from the API test suite. The test that created it is called
  59 *
  60 * testGetBasicLineItem and can be found in
  61 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/LineItemTest.php
  62 *
  63 * You can see the outcome of the API tests at
  64 * https://test.civicrm.org/job/CiviCRM-master-git/
  65 *
  66 * To Learn about the API read
  67 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  68 *
  69 * Browse the api on your own site with the api explorer
  70 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  71 *
  72 * Read more about testing here
  73 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  74 *
  75 * API Standards documentation:
  76 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  77 */