<?php
/**
- * Test Generated example of using price_field_value create API
- * *
+ * @file
+ * Test Generated API Example.
+ * See bottom of this file for more detail.
*/
-function price_field_value_create_example(){
-$params = array(
- 'price_field_id' => 13,
- 'membership_type_id' => 5,
- 'name' => 'memType1',
- 'label' => 'memType1',
- 'amount' => 90,
- 'membership_num_terms' => 2,
- 'is_active' => 1,
- 'financial_type_id' => 2,
-);
-try{
- $result = civicrm_api3('price_field_value', 'create', $params);
-}
-catch (CiviCRM_API3_Exception $e) {
- // handle error here
- $errorMessage = $e->getMessage();
- $errorCode = $e->getErrorCode();
- $errorData = $e->getExtraParams();
- return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
-}
+/**
+ * Test Generated example of using price_field_value create API.
+ *
+ *
+ * @return array
+ * API result array
+ */
+function price_field_value_create_example() {
+ $params = array(
+ 'price_field_id' => 13,
+ 'membership_type_id' => 5,
+ 'name' => 'memType1',
+ 'label' => 'memType1',
+ 'amount' => 90,
+ 'membership_num_terms' => 2,
+ 'is_active' => 1,
+ 'financial_type_id' => 2,
+ );
-return $result;
+ try{
+ $result = civicrm_api3('price_field_value', 'create', $params);
+ }
+ catch (CiviCRM_API3_Exception $e) {
+ // Handle error here.
+ $errorMessage = $e->getMessage();
+ $errorCode = $e->getErrorCode();
+ $errorData = $e->getExtraParams();
+ return array(
+ 'error' => $errorMessage,
+ 'error_code' => $errorCode,
+ 'error_data' => $errorData,
+ );
+ }
+
+ return $result;
}
/**
- * Function returns array of result expected from previous function
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ * API result array
*/
-function price_field_value_create_expectedresult(){
+function price_field_value_create_expectedresult() {
$expectedResult = array(
- 'is_error' => 0,
- 'version' => 3,
- 'count' => 1,
- 'id' => 10,
- 'values' => array(
+ 'is_error' => 0,
+ 'version' => 3,
+ 'count' => 1,
+ 'id' => 10,
+ 'values' => array(
'10' => array(
- 'id' => '10',
- 'price_field_id' => '13',
- 'name' => 'memType1',
- 'label' => 'memType1',
- 'description' => '',
- 'amount' => '90',
- 'count' => '',
- 'max_value' => '',
- 'weight' => '1',
- 'membership_type_id' => '5',
- 'membership_num_terms' => '2',
- 'is_default' => '',
- 'is_active' => '1',
- 'financial_type_id' => '2',
- 'deductible_amount' => '',
- 'contribution_type_id' => '2',
- ),
+ 'id' => '10',
+ 'price_field_id' => '13',
+ 'name' => 'memType1',
+ 'label' => 'memType1',
+ 'description' => '',
+ 'amount' => '90',
+ 'count' => '',
+ 'max_value' => '',
+ 'weight' => '1',
+ 'membership_type_id' => '5',
+ 'membership_num_terms' => '2',
+ 'is_default' => '',
+ 'is_active' => '1',
+ 'financial_type_id' => '2',
+ 'deductible_amount' => '',
+ 'contribution_type_id' => '2',
+ ),
),
-);
+ );
return $expectedResult;
}
-
-/*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testCreatePriceFieldValuewithMultipleTerms and can be found in
+/**
+* This example has been generated from the API test suite.
+* The test that created it is called
+* testCreatePriceFieldValuewithMultipleTerms
+* and can be found in
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PriceFieldValueTest.php
*
* You can see the outcome of the API tests at