api/v3/Premium.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  * File for the CiviCRM APIv3 premium functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_premium
  33  *
  34  */
  35
  36 /**
  37  * Save a premium
  38  *
  39  * Allowed @params array keys are:
  40  * {@getfields premium_create}
  41  * @example premiumCreate.php
  42  *
  43  * @param array $params
  44  *
  45  * @throws API_Exception
  46  * @return array
  47  *   Array of newly created premium property values.
  48  * @access public
  49  */
  50 function civicrm_api3_premium_create($params) {
  51   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  52 }
  53
  54 /**
  55  * Get a premium
  56  *
  57  * Allowed @params array keys are:
  58  * {@getfields premium_get}
  59  * @example premiumCreate.php
  60  *
  61  * @param array $params
  62  *
  63  * @return array
  64  *   Array of retrieved premium property values.
  65  * @access public
  66  */
  67 function civicrm_api3_premium_get($params) {
  68   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  69 }
  70
  71 /**
  72  * Delete a premium
  73  *
  74  * Allowed @params array keys are:
  75  * {@getfields premium_delete}
  76  * @example premiumCreate.php
  77  *
  78  * @param array $params
  79  *
  80  * @throws API_Exception
  81  * @return array
  82  *   Array of deleted values.
  83  * @access public
  84  */
  85 function civicrm_api3_premium_delete($params) {
  86   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  87 }
  88
  89 /**
  90  * return field specification specific to get requests
  91  * @param array $params
  92  */
  93 function _civicrm_api3_premium_get_spec(&$params) {
  94   $params['premiums_active']['api.aliases'] = array('is_active');
  95 }
  96
  97 /**
  98  * return field specification specific to create requests
  99  * @param array $params
 100  */
 101 function _civicrm_api3_premium_create_spec(&$params) {
 102   $params['premiums_active']['api.aliases'] = array('is_active');
 103 }