api/v3/examples/PriceFieldValue/Get.ex.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the PriceFieldValue.get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function price_field_value_get_example() {
   9   $params = [
  10     'name' => 'contribution_amount',
  11   ];
  12
  13   try{
  14     $result = civicrm_api3('PriceFieldValue', 'get', $params);
  15   }
  16   catch (CiviCRM_API3_Exception $e) {
  17     // Handle error here.
  18     $errorMessage = $e->getMessage();
  19     $errorCode = $e->getErrorCode();
  20     $errorData = $e->getExtraParams();
  21     return [
  22       'is_error' => 1,
  23       'error_message' => $errorMessage,
  24       'error_code' => $errorCode,
  25       'error_data' => $errorData,
  26     ];
  27   }
  28
  29   return $result;
  30 }
  31
  32 /**
  33  * Function returns array of result expected from previous function.
  34  *
  35  * @return array
  36  *   API result array
  37  */
  38 function price_field_value_get_expectedresult() {
  39
  40   $expectedResult = [
  41     'is_error' => 0,
  42     'version' => 3,
  43     'count' => 1,
  44     'id' => 1,
  45     'values' => [
  46       '1' => [
  47         'id' => '1',
  48         'price_field_id' => '1',
  49         'name' => 'contribution_amount',
  50         'label' => 'Contribution Amount',
  51         'amount' => '1.000000000',
  52         'weight' => '1',
  53         'is_default' => 0,
  54         'is_active' => '1',
  55         'financial_type_id' => '1',
  56         'non_deductible_amount' => '0.00',
  57         'visibility_id' => '1',
  58         'contribution_type_id' => '1',
  59       ],
  60     ],
  61   ];
  62
  63   return $expectedResult;
  64 }
  65
  66 /*
  67 * This example has been generated from the API test suite.
  68 * The test that created it is called "testGetBasicPriceFieldValue"
  69 * and can be found at:
  70 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceFieldValueTest.php
  71 *
  72 * You can see the outcome of the API tests at
  73 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
  74 *
  75 * To Learn about the API read
  76 * https://docs.civicrm.org/dev/en/latest/api/
  77 *
  78 * Browse the API on your own site with the API Explorer. It is in the main
  79 * CiviCRM menu, under: Support > Development > API Explorer.
  80 *
  81 * Read more about testing here
  82 * https://docs.civicrm.org/dev/en/latest/testing/
  83 *
  84 * API Standards documentation:
  85 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
  86 */