Merge pull request #4923 from colemanw/invoice_id

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

diff --git a/api/v3/PriceSet.php b/api/v3/PriceSet.php
index 2a1635c636c01b1b91a6a2c76a1e39016a4ad439..082b22807544fd4871a5440c571451a266140c3d 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                                |
  +--------------------------------------------------------------------+
@@ -38,13 +37,14 @@
 /**
  * Create or update a price_set
  *
- * @param array $params  Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'price_set'
  * @example PriceSetCreate.php Std Create example
  *
- * @return array api result array
+ * @return array
+ *   api result array
  * {@getfields price_set_create}
- * @access public
  */
 function civicrm_api3_price_set_create($params) {
   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -68,25 +68,28 @@ function civicrm_api3_price_set_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or 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
  *
- * @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
+ * @return array
+ *   Array of matching price_sets
  * {@getfields price_set_get}
- * @access public
  */
 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);
@@ -103,12 +106,13 @@ function civicrm_api3_price_set_get($params) {
  * This method is used to delete any existing price_set. id of the group
  * to be deleted is required field in $params array
  *
- * @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  returns flag true if successfull, error message otherwise
+ * @return array
+ *   API result array
  * {@getfields price_set_delete}
- * @access public
  */
 function civicrm_api3_price_set_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);