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  * File for the CiviCRM APIv3 group functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_PriceSet
  34  * @copyright CiviCRM LLC (c) 20042012
  35  */
  36
  37 /**
  38  * Create or update a price_set
  39  *
  40  * @param array $params
  41  *   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
  46  *   api result array
  47  *   {@getfields price_set_create}
  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  *
  72  * @param array $params
  73  *   Array or parameters determined by getfields.
  74  */
  75 function _civicrm_api3_price_set_create_spec(&$params) {
  76   $params['title']['api.required'] = TRUE;
  77 }
  78
  79 /**
  80  * Returns array of price_sets  matching a set of one or more group properties
  81  *
  82  * @param array $params
  83  *   Array of one or more valid property_name=>value pairs. If $params is set.
  84  *   as null, all price_sets will be returned (default limit is 25)
  85  *
  86  * @return array
  87  *   Array of matching price_sets
  88  *   {@getfields price_set_get}
  89  */
  90 function civicrm_api3_price_set_get($params) {
  91   // hack to make getcount work. - not sure the best approach here
  92   // as creating an alternate getcount function also feels a bit hacky
  93   if (isset($params['options'])  && isset($params['options']['is_count'])) {
  94     return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  95   }
  96   $result = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE);
  97   // Fetch associated entities
  98   foreach ($result as &$item) {
  99     $item['entity'] = CRM_Price_BAO_PriceSet::getUsedBy($item['id'], 'entity');
 100   }
 101   return civicrm_api3_create_success($result, $params);
 102 }
 103
 104 /**
 105  * delete an existing price_set
 106  *
 107  * This method is used to delete any existing price_set. id of the group
 108  * to be deleted is required field in $params array
 109  *
 110  * @param array $params
 111  *   Array containing id of the group.
 112  *   to be deleted
 113  *
 114  * @return array
 115  *   API result array
 116  *   {@getfields price_set_delete}
 117  */
 118 function civicrm_api3_price_set_delete($params) {
 119   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 120 }