3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 premium functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_premium
39 * Allowed @params array keys are:
40 * {@getfields premium_create}
41 * @example premiumCreate.php
43 * @param array $params
45 * @throws API_Exception
47 * Array of newly created premium property values.
49 function civicrm_api3_premium_create($params) {
50 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
56 * Allowed @params array keys are:
57 * {@getfields premium_get}
58 * @example premiumCreate.php
60 * @param array $params
63 * Array of retrieved premium property values.
65 function civicrm_api3_premium_get($params) {
66 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
72 * Allowed @params array keys are:
73 * {@getfields premium_delete}
74 * @example premiumCreate.php
76 * @param array $params
78 * @throws API_Exception
80 * Array of deleted values.
82 function civicrm_api3_premium_delete($params) {
83 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
87 * return field specification specific to get requests
88 * @param array $params
90 function _civicrm_api3_premium_get_spec(&$params) {
91 $params['premiums_active']['api.aliases'] = array('is_active');
95 * return field specification specific to create requests
96 * @param array $params
98 function _civicrm_api3_premium_create_spec(&$params) {
99 $params['premiums_active']['api.aliases'] = array('is_active');