Merge remote-tracking branch 'origin/4.5' into 4.5-master-2015-02-24-17-24-05

[civicrm-core.git] / api / v3 / PriceFieldValue.php

diff --git a/api/v3/PriceFieldValue.php b/api/v3/PriceFieldValue.php
index 76537cd0f1bb575e675aadc414b566833f0dff5b..37a93741d375e1d7c30cc5d3d23a248da33bfe20 100644 (file)
--- a/api/v3/PriceFieldValue.php
+++ b/api/v3/PriceFieldValue.php
@@ -1,5 +1,4 @@
 <?php
-/*
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,31 +23,30 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM price field values.
+ *
+ * PriceFields may contain zero or more PriceFieldValues.
+ * Use chaining to create PriceFields and values in one api call.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_PriceFieldValue
- * @copyright CiviCRM LLC (c) 20042012
  */
 
 /**
- * Create or update a price_field_value
+ * Create or update a PriceFieldValue.
  *
- * @param array $params  Associative array of property
- *                       name/value pairs to insert in new 'price_field_value'
- * @example PriceFieldValueCreate.php Std Create example
+ * @param array $params
+ *   name/value pairs to insert in new 'PriceFieldValue'
  *
- * @return array api result array
- * {@getfields price_field_value_create}
- * @access public
+ * @return array
+ *   API result array.
  */
 function civicrm_api3_price_field_value_create($params) {
   $ids = array();
-  if(!empty($params['id'])){
+  if (!empty($params['id'])) {
     $ids['id'] = $params['id'];
   }
 
@@ -56,15 +54,17 @@ function civicrm_api3_price_field_value_create($params) {
 
   $values = array();
   _civicrm_api3_object_to_array($bao, $values[$bao->id]);
-  return civicrm_api3_create_success($values, $params, 'price_field_value', 'create', $bao);
+  return civicrm_api3_create_success($values, $params, 'PriceFieldValue', 'create', $bao);
 
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_price_field_value_create_spec(&$params) {
   $params['price_field_id']['api.required'] = TRUE;
@@ -74,31 +74,29 @@ function _civicrm_api3_price_field_value_create_spec(&$params) {
 }
 
 /**
- * Returns array of price_field_values  matching a set of one or more group properties
+ * Returns array of PriceFieldValues  matching a set of one or more group properties.
  *
- * @param array $params Array of one or more valid property_name=>value pairs. If $params is set
- *  as null, all price_field_values will be returned (default limit is 25)
+ * @param array $params
+ *   Array of one or more valid property_name=>value pairs. If $params is set.
+ *   as null, all price_field_values will be returned (default limit is 25)
  *
- * @return array  Array of matching price_field_values
- * {@getfields price_field_value_get}
- * @access public
+ * @return array
+ *   API result array.
  */
 function civicrm_api3_price_field_value_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * delete an existing price_field_value
+ * Delete an existing PriceFieldValue.
  *
- * This method is used to delete any existing price_field_value. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing PriceFieldValue given its id.
  *
- * @param array $params array containing id of the group
- *  to be deleted
+ * @param array $params
+ *   Array containing id of the group to be deleted.
  *
- * @return array API result array
- * {@getfields price_field_value_delete}
- * @access public
+ * @return array
+ *   API result array.
  */
 function civicrm_api3_price_field_value_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);