api/v3/PriceSet.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 /**
  30  * This api exposes CiviCRM price sets.
  31  *
  32  * @package CiviCRM_APIv3
  33  */
  34
  35 /**
  36  * Create or update a price_set.
  37  *
  38  * @param array $params
  39  *   name/value pairs to insert in new 'price_set'
  40  *
  41  * @return array
  42  *   api result array
  43  */
  44 function civicrm_api3_price_set_create($params) {
  45   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  46   // Handle price_set_entity
  47   if (!empty($result['id']) && !empty($params['entity_table']) && !empty($params['entity_id'])) {
  48     $entityId = $params['entity_id'];
  49     if (!is_array($params['entity_id'])) {
  50       $entityId = explode(',', $entityId);
  51     }
  52     foreach ($entityId as $eid) {
  53       $eid = (int) trim($eid);
  54       if ($eid) {
  55         CRM_Price_BAO_PriceSet::addTo($params['entity_table'], $eid, $result['id']);
  56       }
  57     }
  58   }
  59   return $result;
  60 }
  61
  62 /**
  63  * Adjust Metadata for Create action.
  64  *
  65  * The metadata is used for setting defaults, documentation & validation.
  66  *
  67  * @param array $params
  68  *   Array of parameters determined by getfields.
  69  */
  70 function _civicrm_api3_price_set_create_spec(&$params) {
  71   $params['title']['api.required'] = TRUE;
  72 }
  73
  74 /**
  75  * Returns array of price_sets matching a set of one or more group properties.
  76  *
  77  * @param array $params
  78  *   Array of one or more valid property_name=>value pairs. If $params is set.
  79  *   as null, all price_sets will be returned (default limit is 25)
  80  *
  81  * @return array
  82  *   Array of matching price_sets
  83  */
  84 function civicrm_api3_price_set_get($params) {
  85   // hack to make getcount work. - not sure the best approach here
  86   // as creating an alternate getcount function also feels a bit hacky
  87   if (isset($params['options'])  && isset($params['options']['is_count'])) {
  88     return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  89   }
  90   $result = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE);
  91   // Fetch associated entities
  92   foreach ($result as &$item) {
  93     $item['entity'] = CRM_Price_BAO_PriceSet::getUsedBy($item['id'], 'entity');
  94   }
  95   return civicrm_api3_create_success($result, $params);
  96 }
  97
  98 /**
  99  * Delete an existing price_set.
 100  *
 101  * This method is used to delete any existing price_set. id of the group
 102  * to be deleted is required field in $params array
 103  *
 104  * @param array $params
 105  *   Array containing id of the group to be deleted.
 106  *
 107  * @return array
 108  *   API result array
 109  */
 110 function civicrm_api3_price_set_delete($params) {
 111   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 112 }