Commit | Line | Data |
---|---|---|
7d9f50a2 | 1 | <?php |
7d9f50a2 CW |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
7d9f50a2 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * File for the CiviCRM APIv3 premium functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_premium | |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Save a premium | |
38 | * | |
39 | * Allowed @params array keys are: | |
40 | * {@getfields premium_create} | |
41 | * @example premiumCreate.php | |
42 | * | |
c490a46a | 43 | * @param array $params |
f84e38ab EM |
44 | * |
45 | * @throws API_Exception | |
a6c01b45 | 46 | * @return array |
16b10e64 | 47 | * Array of newly created premium property values. |
7d9f50a2 CW |
48 | */ |
49 | function civicrm_api3_premium_create($params) { | |
50 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
51 | } | |
52 | ||
53 | /** | |
54 | * Get a premium | |
55 | * | |
56 | * Allowed @params array keys are: | |
57 | * {@getfields premium_get} | |
58 | * @example premiumCreate.php | |
59 | * | |
c490a46a | 60 | * @param array $params |
f84e38ab | 61 | * |
a6c01b45 | 62 | * @return array |
16b10e64 | 63 | * Array of retrieved premium property values. |
7d9f50a2 CW |
64 | */ |
65 | function civicrm_api3_premium_get($params) { | |
66 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
67 | } | |
68 | ||
69 | /** | |
70 | * Delete a premium | |
71 | * | |
72 | * Allowed @params array keys are: | |
73 | * {@getfields premium_delete} | |
74 | * @example premiumCreate.php | |
75 | * | |
c490a46a | 76 | * @param array $params |
f84e38ab EM |
77 | * |
78 | * @throws API_Exception | |
a6c01b45 | 79 | * @return array |
16b10e64 | 80 | * Array of deleted values. |
7d9f50a2 CW |
81 | */ |
82 | function civicrm_api3_premium_delete($params) { | |
83 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
84 | } | |
85 | ||
86 | /** | |
87 | * return field specification specific to get requests | |
d0997921 | 88 | * @param array $params |
7d9f50a2 CW |
89 | */ |
90 | function _civicrm_api3_premium_get_spec(&$params) { | |
eeff08de | 91 | $params['premiums_active']['api.aliases'] = array('is_active'); |
7d9f50a2 CW |
92 | } |
93 | ||
94 | /** | |
95 | * return field specification specific to create requests | |
d0997921 | 96 | * @param array $params |
7d9f50a2 CW |
97 | */ |
98 | function _civicrm_api3_premium_create_spec(&$params) { | |
eeff08de | 99 | $params['premiums_active']['api.aliases'] = array('is_active'); |
7d9f50a2 | 100 | } |