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