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

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

diff --git a/api/v3/PriceSet.php b/api/v3/PriceSet.php
index 5d76ad3f22841a88373e5c240897ee5694994811..17c11c12eaa4c40a98358493a1d79b4d3db4ada2 100644 (file)
--- a/api/v3/PriceSet.php
+++ b/api/v3/PriceSet.php
@@ -1,8 +1,7 @@
 <?php
-/*
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -24,27 +23,26 @@
  | 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 Sets.
+ *
+ * PriceSets contain PriceFields (which have their own api).
+ * Use chaining to create a PriceSet and associated PriceFields in one api call.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_PriceSet
- * @copyright CiviCRM LLC (c) 20042012
  */
 
 /**
- * Create or update a price_set
+ * Create or update a PriceSet.
  *
- * @param array $params  Associative array of property
- *                       name/value pairs to insert in new 'price_set'
- * @example PriceSetCreate.php Std Create example
+ * @param array $params
+ *   name/value pairs to insert in new 'PriceSet'
  *
- * @return array api result array
- * {@getfields price_set_create}
- * @access public
+ * @return array
+ *   api result array
  */
 function civicrm_api3_price_set_create($params) {
   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -65,29 +63,31 @@ function civicrm_api3_price_set_create($params) {
 }
 
 /**
- * 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_set_create_spec(&$params) {
   $params['title']['api.required'] = TRUE;
 }
 
 /**
- * Returns array of price_sets  matching a set of one or more group properties
+ * Returns array of price_sets 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_sets 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_sets will be returned (default limit is 25)
  *
- * @return array  Array of matching price_sets
- * {@getfields price_set_get}
- * @access public
+ * @return array
+ *   Array of matching price_sets
  */
 function civicrm_api3_price_set_get($params) {
   // hack to make getcount work. - not sure the best approach here
   // as creating an alternate getcount function also feels a bit hacky
-  if(isset($params['options'])  && isset($params['options']['is_count'])) {
+  if (isset($params['options'])  && isset($params['options']['is_count'])) {
     return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
   }
   $result = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE);
@@ -99,17 +99,15 @@ function civicrm_api3_price_set_get($params) {
 }
 
 /**
- * delete an existing price_set
+ * Delete an existing PriceSet.
  *
- * This method is used to delete any existing price_set. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing PriceSet 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_set_delete}
- * @access public
+ * @return array
+ *   API result array
  */
 function civicrm_api3_price_set_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);