887f7ad833220bddf5123a43e79d927cb5533487
4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.6 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 group functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_PriceSet
35 * @copyright CiviCRM LLC (c) 20042012
39 * Create or update a price_set
41 * @param array $params
42 * Associative array of property.
43 * name/value pairs to insert in new 'price_set'
44 * @example PriceSetCreate.php Std Create example
48 * {@getfields price_set_create}
51 function civicrm_api3_price_set_create($params) {
52 $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
53 // Handle price_set_entity
54 if (!empty($result['id']) && !empty($params['entity_table']) && !empty($params['entity_id'])) {
55 $entityId = $params['entity_id'];
56 if (!is_array($params['entity_id'])) {
57 $entityId = explode(',', $entityId);
59 foreach ($entityId as $eid) {
60 $eid = (int) trim($eid);
62 CRM_Price_BAO_PriceSet
::addTo($params['entity_table'], $eid, $result['id']);
70 * Adjust Metadata for Create action
72 * The metadata is used for setting defaults, documentation & validation
73 * @param array $params
74 * Array or parameters determined by getfields.
76 function _civicrm_api3_price_set_create_spec(&$params) {
77 $params['title']['api.required'] = TRUE;
81 * Returns array of price_sets matching a set of one or more group properties
83 * @param array $params
84 * Array of one or more valid property_name=>value pairs. If $params is set.
85 * as null, all price_sets will be returned (default limit is 25)
88 * Array of matching price_sets
89 * {@getfields price_set_get}
92 function civicrm_api3_price_set_get($params) {
93 // hack to make getcount work. - not sure the best approach here
94 // as creating an alternate getcount function also feels a bit hacky
95 if (isset($params['options']) && isset($params['options']['is_count'])) {
96 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
98 $result = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, FALSE);
99 // Fetch associated entities
100 foreach ($result as &$item) {
101 $item['entity'] = CRM_Price_BAO_PriceSet
::getUsedBy($item['id'], 'entity');
103 return civicrm_api3_create_success($result, $params);
107 * delete an existing price_set
109 * This method is used to delete any existing price_set. id of the group
110 * to be deleted is required field in $params array
112 * @param array $params
113 * Array containing id of the group.
118 * {@getfields price_set_delete}
121 function civicrm_api3_price_set_delete($params) {
122 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);