api/v3/examples/PriceFieldGet.php

   1 <?php
   2 /**
   3  * Test Generated example of using price_field get API
   4  * *
   5  */
   6 function price_field_get_example(){
   7 $params = array(
   8   'name' => 'contribution_amount',
   9 );
  10
  11 try{
  12   $result = civicrm_api3('price_field', '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 price_field_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           'price_set_id' => '1',
  39           'name' => 'contribution_amount',
  40           'label' => 'Contribution Amount',
  41           'html_type' => 'Text',
  42           'is_enter_qty' => 0,
  43           'weight' => '1',
  44           'is_display_amounts' => '1',
  45           'options_per_line' => '1',
  46           'is_active' => '1',
  47           'is_required' => '1',
  48           'visibility_id' => '1',
  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 * testGetBasicPriceField and can be found in
  61 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/PriceFieldTest.php
  62 *
  63 * You can see the outcome of the API tests at
  64 * http://tests.dev.civicrm.org/trunk/results-api_v3
  65 *
  66 * To Learn about the API read
  67 * http://book.civicrm.org/developer/current/techniques/api/
  68 *
  69 * and review the wiki at
  70 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  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 */