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 premium products. |
30 | * | |
31 | * Premiums are used as incentive gifts on contribution pages. | |
32 | * Use chaining to create a premium and related products in one api call. | |
7d9f50a2 CW |
33 | * |
34 | * @package CiviCRM_APIv3 | |
7d9f50a2 CW |
35 | */ |
36 | ||
37 | /** | |
9d32e6f7 | 38 | * Save a product. |
7d9f50a2 | 39 | * |
c490a46a | 40 | * @param array $params |
1fd111c8 EM |
41 | * |
42 | * @throws API_Exception | |
a6c01b45 | 43 | * @return array |
7d9f50a2 CW |
44 | */ |
45 | function civicrm_api3_product_create($params) { | |
46 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
47 | } | |
48 | ||
a9140b42 EM |
49 | /** |
50 | * Adjust Metadata for Create action. | |
51 | * | |
52 | * The metadata is used for setting defaults, documentation & validation. | |
53 | * | |
54 | * @param array $params | |
55 | * Array of parameters determined by getfields. | |
56 | */ | |
57 | function _civicrm_api3_product_create_spec(&$params) { | |
58 | $params['is_active']['api.default'] = 1; | |
fc9a794a | 59 | $params['name']['api.required'] = 1; |
a9140b42 EM |
60 | } |
61 | ||
7d9f50a2 | 62 | /** |
9d32e6f7 | 63 | * Get a product. |
7d9f50a2 | 64 | * |
c490a46a | 65 | * @param array $params |
1fd111c8 | 66 | * |
a6c01b45 | 67 | * @return array |
16b10e64 | 68 | * Array of retrieved product property values. |
7d9f50a2 CW |
69 | */ |
70 | function civicrm_api3_product_get($params) { | |
71 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
72 | } | |
73 | ||
74 | /** | |
9d32e6f7 | 75 | * Delete a product. |
7d9f50a2 | 76 | * |
c490a46a | 77 | * @param array $params |
1fd111c8 EM |
78 | * |
79 | * @throws API_Exception | |
a6c01b45 | 80 | * @return array |
16b10e64 | 81 | * Array of deleted values. |
7d9f50a2 CW |
82 | */ |
83 | function civicrm_api3_product_delete($params) { | |
84 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
85 | } |