projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| 7d9f50a2 CW |
1 | <?php |
| 2 | ||
| 3 | /* | |
| 4 | +--------------------------------------------------------------------+ | |
| 5 | | CiviCRM version 4.4 | | |
| 6 | +--------------------------------------------------------------------+ | |
| 7 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
| 8 | +--------------------------------------------------------------------+ | |
| 9 | | This file is a part of CiviCRM. | | |
| 10 | | | | |
| 11 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
| 12 | | under the terms of the GNU Affero General Public License | | |
| 13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
| 14 | | | | |
| 15 | | CiviCRM is distributed in the hope that it will be useful, but | | |
| 16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
| 17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
| 18 | | See the GNU Affero General Public License for more details. | | |
| 19 | | | | |
| 20 | | You should have received a copy of the GNU Affero General Public | | |
| 21 | | License and the CiviCRM Licensing Exception along | | |
| 22 | | with this program; if not, contact CiviCRM LLC | | |
| 23 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
| 24 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
| 25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
| 26 | +--------------------------------------------------------------------+ | |
| 27 | */ | |
| 28 | ||
| 29 | /** | |
| 30 | * File for the CiviCRM APIv3 premium functions | |
| 31 | * | |
| 32 | * @package CiviCRM_APIv3 | |
| 33 | * @subpackage API_premium | |
| 34 | * | |
| 35 | */ | |
| 36 | ||
| 37 | /** | |
| 38 | * Save a premium | |
| 39 | * | |
| 40 | * Allowed @params array keys are: | |
| 41 | * {@getfields premium_create} | |
| 42 | * @example premiumCreate.php | |
| 43 | * | |
| 44 | * @return array of newly created premium property values. | |
| 45 | * @access public | |
| 46 | */ | |
| 47 | function civicrm_api3_premium_create($params) { | |
| 48 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 49 | } | |
| 50 | ||
| 51 | /** | |
| 52 | * Get a premium | |
| 53 | * | |
| 54 | * Allowed @params array keys are: | |
| 55 | * {@getfields premium_get} | |
| 56 | * @example premiumCreate.php | |
| 57 | * | |
| 58 | * @return array of retrieved premium property values. | |
| 59 | * @access public | |
| 60 | */ | |
| 61 | function civicrm_api3_premium_get($params) { | |
| 62 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 63 | } | |
| 64 | ||
| 65 | /** | |
| 66 | * Delete a premium | |
| 67 | * | |
| 68 | * Allowed @params array keys are: | |
| 69 | * {@getfields premium_delete} | |
| 70 | * @example premiumCreate.php | |
| 71 | * | |
| 72 | * @return array of deleted values. | |
| 73 | * @access public | |
| 74 | */ | |
| 75 | function civicrm_api3_premium_delete($params) { | |
| 76 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 77 | } | |
| 78 | ||
| 79 | /** | |
| 80 | * return field specification specific to get requests | |
| 81 | */ | |
| 82 | function _civicrm_api3_premium_get_spec(&$params) { | |
| 83 | $params['premium_active']['api.aliases'] = array('is_active'); | |
| 84 | } | |
| 85 | ||
| 86 | /** | |
| 87 | * return field specification specific to create requests | |
| 88 | */ | |
| 89 | function _civicrm_api3_premium_create_spec(&$params) { | |
| 90 | $params['premium_active']['api.aliases'] = array('is_active'); | |
| 91 | } |