X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FPremium.php;h=e2c408df8d6f42134ecaef1df26f51dcdbf8e051;hb=66ea266254f36e0c41bea02df9bf64160fef1a0e;hp=aedd3a9fb106a740a5b85f9e02746eb530391d4f;hpb=00ca8648aca9637f2678082ce09f98772533a8cc;p=civicrm-core.git

diff --git a/api/v3/Premium.php b/api/v3/Premium.php
index aedd3a9fb1..e2c408df8d 100644
--- a/api/v3/Premium.php
+++ b/api/v3/Premium.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | 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,69 @@
  | 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 premium functions
+ * This api exposes CiviCRM premiums.
  *
- * @package CiviCRM_APIv3
- * @subpackage API_premium
+ * Premiums are used as incentive gifts on contribution pages.
+ * Premiums contain "Products" which has a separate api.
+ * Use chaining to create a premium and related products in one api call.
  *
+ * @package CiviCRM_APIv3
  */
 
 /**
- * Save a premium
+ * Save a premium.
  *
- * Allowed @params array keys are:
- * {@getfields premium_create}
- * @example premiumCreate.php
+ * @param array $params
  *
- * @return array of newly created premium property values.
- * @access public
+ * @throws API_Exception
+ * @return array
  */
 function civicrm_api3_premium_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Get a premium
+ * Get a premium.
  *
- * Allowed @params array keys are:
- * {@getfields premium_get}
- * @example premiumCreate.php
+ * @param array $params
  *
- * @return array of retrieved premium property values.
- * @access public
+ * @return array
+ *   Array of retrieved premium property values.
  */
 function civicrm_api3_premium_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Delete a premium
+ * Delete a premium.
  *
- * Allowed @params array keys are:
- * {@getfields premium_delete}
- * @example premiumCreate.php
+ * @param array $params
  *
- * @return array of deleted values.
- * @access public
+ * @throws API_Exception
+ * @return array
+ *   Array of deleted values.
  */
 function civicrm_api3_premium_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * return field specification specific to get requests
+ * Return field specification specific to get requests.
+ *
+ * @param array $params
  */
 function _civicrm_api3_premium_get_spec(&$params) {
-  $params['premium_active']['api.aliases'] = array('is_active');
+  $params['premiums_active']['api.aliases'] = array('is_active');
 }
 
 /**
- * return field specification specific to create requests
+ * Return field specification specific to create requests.
+ *
+ * @param array $params
  */
 function _civicrm_api3_premium_create_spec(&$params) {
-  $params['premium_active']['api.aliases'] = array('is_active');
+  $params['premiums_active']['api.aliases'] = array('is_active');
 }