CRM-16701 - worked around issue creating saved search.

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

diff --git a/api/v3/PriceField.php b/api/v3/PriceField.php
index cb6fc1e77d9b3fc0c31c104730f8c91773dce247..81237b91e3aa479751bddc74336ae44574b1cceb 100644 (file)
--- a/api/v3/PriceField.php
+++ b/api/v3/PriceField.php
@@ -1,10 +1,9 @@
 <?php
-/*
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -24,68 +23,68 @@
  | 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 set fields.
+ *
+ * PriceSets contain PriceFields, which may contain PriceFieldValues.
+ * Each has its own api.
+ * Use chaining to create a PriceSet and associated PriceFields and values in one api call.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_PriceField
- * @copyright CiviCRM LLC (c) 20042012
  */
 
 /**
- * Create or update a price_field
+ * Create or update a price_field.
  *
- * @param array $params  Associative array of property
- *                       name/value pairs to insert in new 'price_field'
- * @example PriceFieldCreate.php Std Create example
+ * @param array $params
+ *   name/value pairs to insert in new 'price_field'
  *
- * @return array api result array
- * {@getfields price_field_create}
- * @access public
+ * @return array
+ *   api result array
  */
 function civicrm_api3_price_field_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $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_field_create_spec(&$params) {
   $params['label']['api.required'] = TRUE;
 }
 
 /**
- * Returns array of price_fields  matching a set of one or more group properties
+ * Returns array of price_fields 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_fields 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_fields will be returned (default limit is 25)
  *
- * @return array  Array of matching price_fields
- * {@getfields price_field_get}
- * @access public
+ * @return array
+ *   Array of matching price_fields
  */
 function civicrm_api3_price_field_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * delete an existing price_field
+ * Delete an existing price_field.
  *
- * This method is used to delete any existing price_field. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing price_field 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_delete}
- * @access public
+ * @return array
+ *   API result array
  */
 function civicrm_api3_price_field_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);