Cleanup deprecated CRM_Core_BAO_Settings calls CRM-17507
[civicrm-core.git] / CRM / Price / Page / Field.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
7e9e8871 4 | CiviCRM version 4.7 |
6a488035 5 +--------------------------------------------------------------------+
e7112fa7 6 | Copyright CiviCRM LLC (c) 2004-2015 |
6a488035
TO
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 +--------------------------------------------------------------------+
d25dd0ee 26 */
6a488035
TO
27
28/**
29 *
30 * @package CRM
e7112fa7 31 * @copyright CiviCRM LLC (c) 2004-2015
6a488035
TO
32 * $Id$
33 *
34 */
35
36/**
37 * Create a page for displaying Price Fields.
38 *
39 * Heart of this class is the run method which checks
40 * for action type and then displays the appropriate
41 * page.
42 *
43 */
44class CRM_Price_Page_Field extends CRM_Core_Page {
45
96f50de2
CW
46 public $useLivePageJS = TRUE;
47
6a488035 48 /**
fe482240 49 * The price set group id of the field.
6a488035
TO
50 *
51 * @var int
6a488035
TO
52 */
53 protected $_sid;
54
55 /**
fe482240 56 * The action links that we need to display for the browse screen.
6a488035
TO
57 *
58 * @var array
6a488035
TO
59 */
60 private static $_actionLinks;
61
62 /**
fe482240 63 * The price set is reserved or not.
6a488035
TO
64 *
65 * @var boolean
6a488035 66 */
ba1dcfda 67 protected $_isSetReserved = FALSE;
6a488035
TO
68
69 /**
70 * Get the action links for this page.
71 *
a6c01b45
CW
72 * @return array
73 * array of action links that we need to display for the browse screen
95ea96be 74 */
79d7553f 75 public function &actionLinks() {
6a488035 76 if (!isset(self::$_actionLinks)) {
6a488035
TO
77 self::$_actionLinks = array(
78 CRM_Core_Action::UPDATE => array(
79 'name' => ts('Edit Price Field'),
80 'url' => 'civicrm/admin/price/field',
81 'qs' => 'action=update&reset=1&sid=%%sid%%&fid=%%fid%%',
82 'title' => ts('Edit Price'),
83 ),
84 CRM_Core_Action::PREVIEW => array(
85 'name' => ts('Preview Field'),
86 'url' => 'civicrm/admin/price/field',
87 'qs' => 'action=preview&reset=1&sid=%%sid%%&fid=%%fid%%',
88 'title' => ts('Preview Price'),
89 ),
90 CRM_Core_Action::DISABLE => array(
91 'name' => ts('Disable'),
4d17a233 92 'ref' => 'crm-enable-disable',
6a488035
TO
93 'title' => ts('Disable Price'),
94 ),
95 CRM_Core_Action::ENABLE => array(
96 'name' => ts('Enable'),
4d17a233 97 'ref' => 'crm-enable-disable',
6a488035
TO
98 'title' => ts('Enable Price'),
99 ),
100 CRM_Core_Action::DELETE => array(
101 'name' => ts('Delete'),
102 'url' => 'civicrm/admin/price/field',
103 'qs' => 'action=delete&reset=1&sid=%%sid%%&fid=%%fid%%',
104 'title' => ts('Delete Price'),
6a488035
TO
105 ),
106 );
107 }
108 return self::$_actionLinks;
109 }
110
111 /**
112 * Browse all price set fields.
113 *
6a488035 114 * @return void
6a488035 115 */
00be9182 116 public function browse() {
6f231148
CW
117 $resourceManager = CRM_Core_Resources::singleton();
118 if (!empty($_GET['new']) && $resourceManager->ajaxPopupsEnabled) {
96ed17aa 119 $resourceManager->addScriptFile('civicrm', 'js/crm.addNew.js', 999, 'html-header');
6f231148
CW
120 }
121
353ffa53 122 $priceField = array();
9da8dc8c 123 $priceFieldBAO = new CRM_Price_BAO_PriceField();
6a488035
TO
124
125 // fkey is sid
126 $priceFieldBAO->price_set_id = $this->_sid;
127 $priceFieldBAO->orderBy('weight, label');
128 $priceFieldBAO->find();
44c8822b 129
03b412ae 130 // display taxTerm for priceFields
aaffa79f 131 $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
03b412ae
PB
132 $taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
133 $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
a32709be
PB
134 $getTaxDetails = FALSE;
135 $taxRate = CRM_Core_PseudoConstant::getTaxRates();
e3ca0d21 136 CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
6a488035
TO
137 while ($priceFieldBAO->fetch()) {
138 $priceField[$priceFieldBAO->id] = array();
139 CRM_Core_DAO::storeValues($priceFieldBAO, $priceField[$priceFieldBAO->id]);
140
141 // get price if it's a text field
142 if ($priceFieldBAO->html_type == 'Text') {
143 $optionValues = array();
144 $params = array('price_field_id' => $priceFieldBAO->id);
145
9da8dc8c 146 CRM_Price_BAO_PriceFieldValue::retrieve($params, $optionValues);
40c655aa 147 $financialTypeId = $optionValues['financial_type_id'];
89ac6b6d
E
148 if (!array_key_exists($financialTypeId, $financialTypes)) {
149 unset($priceField[$priceFieldBAO->id]);
150 continue;
151 }
6a488035 152 $priceField[$priceFieldBAO->id]['price'] = CRM_Utils_Array::value('amount', $optionValues);
03b412ae 153 if ($invoicing && isset($taxRate[$financialTypeId])) {
a32709be
PB
154 $priceField[$priceFieldBAO->id]['tax_rate'] = $taxRate[$financialTypeId];
155 $getTaxDetails = TRUE;
156 }
157 if (isset($priceField[$priceFieldBAO->id]['tax_rate'])) {
158 $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($priceField[$priceFieldBAO->id]['price'], $priceField[$priceFieldBAO->id]['tax_rate']);
159 $priceField[$priceFieldBAO->id]['tax_amount'] = $taxAmount['tax_amount'];
160 }
6a488035 161 }
44c8822b 162
6a488035
TO
163 $action = array_sum(array_keys($this->actionLinks()));
164
165 if ($this->_isSetReserved) {
166 $action -= CRM_Core_Action::UPDATE + CRM_Core_Action::DELETE + CRM_Core_Action::ENABLE + CRM_Core_Action::DISABLE;
167 }
168 else {
169 if ($priceFieldBAO->is_active) {
170 $action -= CRM_Core_Action::ENABLE;
171 }
172 else {
173 $action -= CRM_Core_Action::DISABLE;
174 }
175 }
176
177 if ($priceFieldBAO->active_on == '0000-00-00 00:00:00') {
178 $priceField[$priceFieldBAO->id]['active_on'] = '';
179 }
180
181 if ($priceFieldBAO->expire_on == '0000-00-00 00:00:00') {
182 $priceField[$priceFieldBAO->id]['expire_on'] = '';
183 }
184
185 // need to translate html types from the db
9da8dc8c 186 $htmlTypes = CRM_Price_BAO_PriceField::htmlTypes();
79c04577 187 $priceField[$priceFieldBAO->id]['html_type_display'] = $htmlTypes[$priceField[$priceFieldBAO->id]['html_type']];
6a488035 188 $priceField[$priceFieldBAO->id]['order'] = $priceField[$priceFieldBAO->id]['weight'];
87dab4a4
AH
189 $priceField[$priceFieldBAO->id]['action'] = CRM_Core_Action::formLink(
190 self::actionLinks(),
191 $action,
6a488035
TO
192 array(
193 'fid' => $priceFieldBAO->id,
194 'sid' => $this->_sid,
87dab4a4
AH
195 ),
196 ts('more'),
197 FALSE,
198 'priceField.row.actions',
199 'PriceField',
200 $priceFieldBAO->id
6a488035 201 );
03b412ae 202 $this->assign('taxTerm', $taxTerm);
a32709be 203 $this->assign('getTaxDetails', $getTaxDetails);
6a488035
TO
204 }
205
206 $returnURL = CRM_Utils_System::url('civicrm/admin/price/field', "reset=1&action=browse&sid={$this->_sid}");
207 $filter = "price_set_id = {$this->_sid}";
9da8dc8c 208 CRM_Utils_Weight::addOrder($priceField, 'CRM_Price_DAO_PriceField',
6a488035
TO
209 'id', $returnURL, $filter
210 );
211 $this->assign('priceField', $priceField);
212 }
213
214 /**
100fef9d 215 * Edit price data.
6a488035
TO
216 *
217 * editing would involved modifying existing fields + adding data to new fields.
218 *
414c1420
TO
219 * @param string $action
220 * The action to be invoked.
6a488035
TO
221 *
222 * @return void
6a488035 223 */
00be9182 224 public function edit($action) {
6a488035
TO
225 // create a simple controller for editing price data
226 $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_Field', ts('Price Field'), $action);
227
228 // set the userContext stack
229 $session = CRM_Core_Session::singleton();
230 $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid));
231
232 $controller->set('sid', $this->_sid);
233 $controller->setEmbedded(TRUE);
234 $controller->process();
235 $controller->run();
236 }
237
238 /**
239 * Run the page.
240 *
241 * This method is called after the page is created. It checks for the
242 * type of action and executes that action.
243 *
6a488035 244 * @return void
6a488035 245 */
00be9182 246 public function run() {
6a488035
TO
247
248 // get the group id
249 $this->_sid = CRM_Utils_Request::retrieve('sid', 'Positive',
250 $this
251 );
252 $fid = CRM_Utils_Request::retrieve('fid', 'Positive',
253 $this, FALSE, 0
254 );
255 $action = CRM_Utils_Request::retrieve('action', 'String',
256 // default to 'browse'
257 $this, FALSE, 'browse'
258 );
259
260 if ($this->_sid) {
9da8dc8c 261 $usedBy = CRM_Price_BAO_PriceSet::getUsedBy($this->_sid);
6a488035 262 $this->assign('usedBy', $usedBy);
ba1dcfda 263 $this->_isSetReserved = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid, 'is_reserved');
6a488035 264 $this->assign('isReserved', $this->_isSetReserved);
44c8822b 265
9da8dc8c 266 CRM_Price_BAO_PriceSet::checkPermission($this->_sid);
6a488035
TO
267 $comps = array(
268 'Event' => 'civicrm_event',
269 'Contribution' => 'civicrm_contribution_page',
21dfd5f5 270 'EventTemplate' => 'civicrm_event_template',
6a488035
TO
271 );
272 $priceSetContexts = array();
273 foreach ($comps as $name => $table) {
274 if (array_key_exists($table, $usedBy)) {
275 $priceSetContexts[] = $name;
276 }
277 }
278 $this->assign('contexts', $priceSetContexts);
279 }
280
281 if ($action & (CRM_Core_Action::DELETE) && !$this->_isSetReserved) {
282 if (empty($usedBy)) {
283 // prompt to delete
284 $session = CRM_Core_Session::singleton();
285 $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid));
286 $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_DeleteField', 'Delete Price Field', '');
287 $controller->set('fid', $fid);
288 $controller->setEmbedded(TRUE);
289 $controller->process();
290 $controller->run();
291 }
292 else {
293 // add breadcrumb
294 $url = CRM_Utils_System::url('civicrm/admin/price/field', 'reset=1');
295 CRM_Utils_System::appendBreadCrumb(ts('Price'),
296 $url
297 );
9da8dc8c 298 $this->assign('usedPriceSetTitle', CRM_Price_BAO_PriceField::getTitle($fid));
6a488035
TO
299 }
300 }
301
e5e8ab99
CW
302 if ($action & CRM_Core_Action::DELETE) {
303 CRM_Utils_System::setTitle(ts('Delete Price Field'));
304 }
305 elseif ($this->_sid) {
9da8dc8c 306 $groupTitle = CRM_Price_BAO_PriceSet::getTitle($this->_sid);
6a488035
TO
307 $this->assign('sid', $this->_sid);
308 $this->assign('groupTitle', $groupTitle);
309 CRM_Utils_System::setTitle(ts('%1 - Price Fields', array(1 => $groupTitle)));
310 }
311
312 // assign vars to templates
313 $this->assign('action', $action);
314
315 // what action to take ?
316 if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD) && !$this->_isSetReserved) {
317 // no browse for edit/update/view
318 $this->edit($action);
319 }
320 elseif ($action & CRM_Core_Action::PREVIEW) {
321 $this->preview($fid);
322 }
323 else {
324 $this->browse();
325 }
326
327 // Call the parents run method
328 return parent::run();
329 }
330
331 /**
fe482240 332 * Preview price field.
6a488035 333 *
100fef9d 334 * @param int $fid
77b97be7
EM
335 *
336 * @internal param int $id price field id
6a488035
TO
337 *
338 * @return void
6a488035 339 */
00be9182 340 public function preview($fid) {
6a488035
TO
341 $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_Preview', ts('Preview Form Field'), CRM_Core_Action::PREVIEW);
342 $session = CRM_Core_Session::singleton();
343 $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid));
344 $controller->set('fieldId', $fid);
345 $controller->set('groupId', $this->_sid);
346 $controller->setEmbedded(TRUE);
347 $controller->process();
348 $controller->run();
349 }
96025800 350
6a488035 351}