projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| a9140b42 EM |
1 | <?php |
| 2 | /* | |
| 3 | +--------------------------------------------------------------------+ | |
| fee14197 | 4 | | CiviCRM version 5 | |
| a9140b42 | 5 | +--------------------------------------------------------------------+ |
| 6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
| a9140b42 EM |
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 | * This api exposes CiviCRM premium products attached to contributions. | |
| 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. | |
| 33 | * | |
| 34 | * @package CiviCRM_APIv3 | |
| 35 | */ | |
| 36 | ||
| 37 | /** | |
| 38 | * Save a contribution product. | |
| 39 | * | |
| 40 | * @param array $params | |
| 41 | * | |
| 42 | * @throws API_Exception | |
| 43 | * @return array | |
| 44 | */ | |
| 45 | function civicrm_api3_contribution_product_create($params) { | |
| a25b46e9 | 46 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ContributionProduct'); |
| a9140b42 EM |
47 | } |
| 48 | ||
| 49 | /** | |
| 50 | * Get a contribution product. | |
| 51 | * | |
| 52 | * @param array $params | |
| 53 | * | |
| 54 | * @return array | |
| 55 | * Array of retrieved product property values. | |
| 56 | */ | |
| 57 | function civicrm_api3_contribution_product_get($params) { | |
| 58 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 59 | } | |
| 60 | ||
| 61 | /** | |
| 62 | * Delete a contribution product. | |
| 63 | * | |
| 64 | * @param array $params | |
| 65 | * | |
| 66 | * @throws API_Exception | |
| 67 | * @return array | |
| 68 | * Array of deleted values. | |
| 69 | */ | |
| 70 | function civicrm_api3_contribution_product_delete($params) { | |
| 71 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 72 | } |