projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Checkstyle fix - one pesky whitespace
[civicrm-core.git]
/
api
/
v3
/
Premium.php
diff --git
a/api/v3/Premium.php
b/api/v3/Premium.php
index 52827ccc1e38c555119cbbcc482c7ab3e9a505f1..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,7
+26,11
@@
*/
/**
*/
/**
- * This api exposes CiviCRM premium.
+ * This api exposes CiviCRM premiums.
+ *
+ * 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
*/
*
* @package CiviCRM_APIv3
*/
@@
-38,7
+42,6
@@
*
* @throws API_Exception
* @return array
*
* @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);