Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
39de6fd5 | 5 | | CiviCRM version 4.6 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | * | |
cf470720 TO |
41 | * @param array $params |
42 | * Associative array of property. | |
6a488035 TO |
43 | * name/value pairs to insert in new 'price_set' |
44 | * @example PriceSetCreate.php Std Create example | |
45 | * | |
46 | * @return array api result array | |
47 | * {@getfields price_set_create} | |
48 | * @access public | |
49 | */ | |
50 | function civicrm_api3_price_set_create($params) { | |
51 | $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
52 | // Handle price_set_entity | |
53 | if (!empty($result['id']) && !empty($params['entity_table']) && !empty($params['entity_id'])) { | |
54 | $entityId = $params['entity_id']; | |
55 | if (!is_array($params['entity_id'])) { | |
56 | $entityId = explode(',', $entityId); | |
57 | } | |
58 | foreach ($entityId as $eid) { | |
59 | $eid = (int) trim($eid); | |
60 | if ($eid) { | |
9da8dc8c | 61 | CRM_Price_BAO_PriceSet::addTo($params['entity_table'], $eid, $result['id']); |
6a488035 TO |
62 | } |
63 | } | |
64 | } | |
65 | return $result; | |
66 | } | |
67 | ||
11e09c59 | 68 | /** |
6a488035 TO |
69 | * Adjust Metadata for Create action |
70 | * | |
71 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
72 | * @param array $params |
73 | * Array or parameters determined by getfields. | |
6a488035 TO |
74 | */ |
75 | function _civicrm_api3_price_set_create_spec(&$params) { | |
e0c1764e | 76 | $params['title']['api.required'] = TRUE; |
6a488035 TO |
77 | } |
78 | ||
79 | /** | |
80 | * Returns array of price_sets matching a set of one or more group properties | |
81 | * | |
cf470720 TO |
82 | * @param array $params |
83 | * Array of one or more valid property_name=>value pairs. If $params is set. | |
6a488035 TO |
84 | * as null, all price_sets will be returned (default limit is 25) |
85 | * | |
86 | * @return array Array of matching price_sets | |
87 | * {@getfields price_set_get} | |
88 | * @access public | |
89 | */ | |
90 | function civicrm_api3_price_set_get($params) { | |
418e884f | 91 | // hack to make getcount work. - not sure the best approach here |
92 | // as creating an alternate getcount function also feels a bit hacky | |
22e263ad | 93 | if (isset($params['options']) && isset($params['options']['is_count'])) { |
418e884f | 94 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
95 | } | |
6a488035 TO |
96 | $result = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE); |
97 | // Fetch associated entities | |
98 | foreach ($result as &$item) { | |
9da8dc8c | 99 | $item['entity'] = CRM_Price_BAO_PriceSet::getUsedBy($item['id'], 'entity'); |
6a488035 TO |
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 | * | |
cf470720 TO |
110 | * @param array $params |
111 | * Array containing id of the group. | |
6a488035 TO |
112 | * to be deleted |
113 | * | |
c206647d | 114 | * @return array API result array |
6a488035 TO |
115 | * {@getfields price_set_delete} |
116 | * @access public | |
117 | */ | |
118 | function civicrm_api3_price_set_delete($params) { | |
119 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
120 | } |