Commit | Line | Data |
---|---|---|
7d9f50a2 | 1 | <?php |
7d9f50a2 CW |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
7d9f50a2 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
7d9f50a2 CW |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
7d9f50a2 CW |
27 | |
28 | /** | |
244bbdd8 CW |
29 | * This api exposes CiviCRM premiums. |
30 | * | |
31 | * Premiums are used as incentive gifts on contribution pages. | |
32 | * Premiums contain "Products" which has a separate api. | |
33 | * Use chaining to create a premium and related products in one api call. | |
7d9f50a2 CW |
34 | * |
35 | * @package CiviCRM_APIv3 | |
7d9f50a2 CW |
36 | */ |
37 | ||
38 | /** | |
9d32e6f7 | 39 | * Save a premium. |
7d9f50a2 | 40 | * |
c490a46a | 41 | * @param array $params |
f84e38ab EM |
42 | * |
43 | * @throws API_Exception | |
a6c01b45 | 44 | * @return array |
7d9f50a2 CW |
45 | */ |
46 | function civicrm_api3_premium_create($params) { | |
47 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
48 | } | |
49 | ||
50 | /** | |
9d32e6f7 | 51 | * Get a premium. |
7d9f50a2 | 52 | * |
c490a46a | 53 | * @param array $params |
f84e38ab | 54 | * |
a6c01b45 | 55 | * @return array |
16b10e64 | 56 | * Array of retrieved premium property values. |
7d9f50a2 CW |
57 | */ |
58 | function civicrm_api3_premium_get($params) { | |
59 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
60 | } | |
61 | ||
62 | /** | |
9d32e6f7 | 63 | * Delete a premium. |
7d9f50a2 | 64 | * |
c490a46a | 65 | * @param array $params |
f84e38ab EM |
66 | * |
67 | * @throws API_Exception | |
a6c01b45 | 68 | * @return array |
16b10e64 | 69 | * Array of deleted values. |
7d9f50a2 CW |
70 | */ |
71 | function civicrm_api3_premium_delete($params) { | |
72 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
73 | } | |
74 | ||
75 | /** | |
9d32e6f7 EM |
76 | * Return field specification specific to get requests. |
77 | * | |
d0997921 | 78 | * @param array $params |
7d9f50a2 CW |
79 | */ |
80 | function _civicrm_api3_premium_get_spec(&$params) { | |
eeff08de | 81 | $params['premiums_active']['api.aliases'] = array('is_active'); |
7d9f50a2 CW |
82 | } |
83 | ||
84 | /** | |
9d32e6f7 EM |
85 | * Return field specification specific to create requests. |
86 | * | |
d0997921 | 87 | * @param array $params |
7d9f50a2 CW |
88 | */ |
89 | function _civicrm_api3_premium_create_spec(&$params) { | |
eeff08de | 90 | $params['premiums_active']['api.aliases'] = array('is_active'); |
7d9f50a2 | 91 | } |