api/v3/Premium.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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 premiums.
  30  *
  31  * Premiums are used as incentive gifts on contribution pages.
  32  * Premiums contain "Products" which has a separate api.
  33  * Use chaining to create a premium and related products in one api call.
  34  *
  35  * @package CiviCRM_APIv3
  36  */
  37
  38 /**
  39  * Save a premium.
  40  *
  41  * @param array $params
  42  *
  43  * @throws API_Exception
  44  * @return array
  45  */
  46 function civicrm_api3_premium_create($params) {
  47   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Premium');
  48 }
  49
  50 /**
  51  * Get a premium.
  52  *
  53  * @param array $params
  54  *
  55  * @return array
  56  *   Array of retrieved premium property values.
  57  */
  58 function civicrm_api3_premium_get($params) {
  59   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  60 }
  61
  62 /**
  63  * Delete a premium.
  64  *
  65  * @param array $params
  66  *
  67  * @throws API_Exception
  68  * @return array
  69  *   Array of deleted values.
  70  */
  71 function civicrm_api3_premium_delete($params) {
  72   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  73 }
  74
  75 /**
  76  * Return field specification specific to get requests.
  77  *
  78  * @param array $params
  79  */
  80 function _civicrm_api3_premium_get_spec(&$params) {
  81   $params['premiums_active']['api.aliases'] = array('is_active');
  82 }
  83
  84 /**
  85  * Return field specification specific to create requests.
  86  *
  87  * @param array $params
  88  */
  89 function _civicrm_api3_premium_create_spec(&$params) {
  90   $params['premiums_active']['api.aliases'] = array('is_active');
  91 }