projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
CRM-16173 - WhitelistSubscriber - Filtering for API requests (entity/action/params)
[civicrm-core.git]
/
api
/
v3
/
Premium.php
diff --git
a/api/v3/Premium.php
b/api/v3/Premium.php
index 0e6ce88fe32acb046eaf80976b95d82d5f7c2294..e2c408df8d6f42134ecaef1df26f51dcdbf8e051 100644
(file)
--- a/
api/v3/Premium.php
+++ b/
api/v3/Premium.php
@@
-3,7
+3,7
@@
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-201
4
|
+ | Copyright CiviCRM LLC (c) 2004-201
5
|
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
@@
-26,36
+26,29
@@
*/
/**
*/
/**
- *
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
- *
- * Allowed @params array keys are:
- * {@getfields premium_create}
- * @example premiumCreate.php
+ * Save a premium.
*
* @param array $params
*
* @throws API_Exception
* @return array
*
* @param array $params
*
* @throws API_Exception
* @return array
- * Array of newly created premium property values.
*/
function civicrm_api3_premium_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
*/
function civicrm_api3_premium_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Get a premium
- *
- * Allowed @params array keys are:
- * {@getfields premium_get}
- * @example premiumCreate.php
+ * Get a premium.
*
* @param array $params
*
*
* @param array $params
*
@@
-67,11
+60,7
@@
function civicrm_api3_premium_get($params) {
}
/**
}
/**
- * Delete a premium
- *
- * Allowed @params array keys are:
- * {@getfields premium_delete}
- * @example premiumCreate.php
+ * Delete a premium.
*
* @param array $params
*
*
* @param array $params
*
@@
-84,7
+73,8
@@
function civicrm_api3_premium_delete($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) {
* @param array $params
*/
function _civicrm_api3_premium_get_spec(&$params) {
@@
-92,7
+82,8
@@
function _civicrm_api3_premium_get_spec(&$params) {
}
/**
}
/**
- * return field specification specific to create requests
+ * Return field specification specific to create requests.
+ *
* @param array $params
*/
function _civicrm_api3_premium_create_spec(&$params) {
* @param array $params
*/
function _civicrm_api3_premium_create_spec(&$params) {