api/v3/PriceSet.php

   1 <?php
   2 /*
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29
  30 /**
  31  * File for the CiviCRM APIv3 group functions
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_PriceSet
  35  * @copyright CiviCRM LLC (c) 20042012
  36  */
  37
  38 /**
  39  * Create or update a price_set
  40  *
  41  * @param array $params  Associative array of property
  42  *                       name/value pairs to insert in new 'price_set'
  43  * @example PriceSetCreate.php Std Create example
  44  *
  45  * @return array api result array
  46  * {@getfields price_set_create}
  47  * @access public
  48  */
  49 function civicrm_api3_price_set_create($params) {
  50   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51   // Handle price_set_entity
  52   if (!empty($result['id']) && !empty($params['entity_table']) && !empty($params['entity_id'])) {
  53     $entityId = $params['entity_id'];
  54     if (!is_array($params['entity_id'])) {
  55       $entityId = explode(',', $entityId);
  56     }
  57     foreach ($entityId as $eid) {
  58       $eid = (int) trim($eid);
  59       if ($eid) {
  60         CRM_Price_BAO_PriceSet::addTo($params['entity_table'], $eid, $result['id']);
  61       }
  62     }
  63   }
  64   return $result;
  65 }
  66
  67 /**
  68  * Adjust Metadata for Create action
  69  *
  70  * The metadata is used for setting defaults, documentation & validation
  71  * @param array $params array or 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 Array of one or more valid property_name=>value pairs. If $params is set
  81  *  as null, all price_sets will be returned (default limit is 25)
  82  *
  83  * @return array  Array of matching price_sets
  84  * {@getfields price_set_get}
  85  * @access public
  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 price_set
 103  *
 104  * This method is used to delete any existing price_set. id of the group
 105  * to be deleted is required field in $params array
 106  *
 107  * @param array $params array containing id of the group
 108  *  to be deleted
 109  *
 110  * @return array  returns flag true if successfull, error message otherwise
 111  * {@getfields price_set_delete}
 112  * @access public
 113  */
 114 function civicrm_api3_price_set_delete($params) {
 115   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 116 }