3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
37 * Create a page for displaying Price Fields.
39 * Heart of this class is the run method which checks
40 * for action type and then displays the appropriate
44 class CRM_Price_Page_Field
extends CRM_Core_Page
{
46 public $useLivePageJS = TRUE;
49 * The price set group id of the field.
56 * The action links that we need to display for the browse screen.
60 private static $_actionLinks;
63 * The price set is reserved or not.
67 protected $_isSetReserved = FALSE;
70 * Get the action links for this page.
73 * array of action links that we need to display for the browse screen
75 public static function &actionLinks() {
76 if (!isset(self
::$_actionLinks)) {
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'),
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'),
90 CRM_Core_Action
::DISABLE
=> array(
91 'name' => ts('Disable'),
92 'ref' => 'crm-enable-disable',
93 'title' => ts('Disable Price'),
95 CRM_Core_Action
::ENABLE
=> array(
96 'name' => ts('Enable'),
97 'ref' => 'crm-enable-disable',
98 'title' => ts('Enable Price'),
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'),
108 return self
::$_actionLinks;
112 * Browse all price set fields.
114 public function browse() {
115 $resourceManager = CRM_Core_Resources
::singleton();
116 if (!empty($_GET['new']) && $resourceManager->ajaxPopupsEnabled
) {
117 $resourceManager->addScriptFile('civicrm', 'js/crm.addNew.js', 999, 'html-header');
120 $priceField = array();
121 $priceFieldBAO = new CRM_Price_BAO_PriceField();
124 $priceFieldBAO->price_set_id
= $this->_sid
;
125 $priceFieldBAO->orderBy('weight, label');
126 $priceFieldBAO->find();
128 // display taxTerm for priceFields
129 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
130 $taxTerm = CRM_Utils_Array
::value('tax_term', $invoiceSettings);
131 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
132 $getTaxDetails = FALSE;
133 $taxRate = CRM_Core_PseudoConstant
::getTaxRates();
134 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes);
135 while ($priceFieldBAO->fetch()) {
136 $priceField[$priceFieldBAO->id
] = array();
137 CRM_Core_DAO
::storeValues($priceFieldBAO, $priceField[$priceFieldBAO->id
]);
139 // get price if it's a text field
140 if ($priceFieldBAO->html_type
== 'Text') {
141 $optionValues = array();
142 $params = array('price_field_id' => $priceFieldBAO->id
);
144 CRM_Price_BAO_PriceFieldValue
::retrieve($params, $optionValues);
145 $priceField[$priceFieldBAO->id
]['price'] = CRM_Utils_Array
::value('amount', $optionValues);
146 $financialTypeId = $optionValues['financial_type_id'];
147 if ($invoicing && isset($taxRate[$financialTypeId])) {
148 $priceField[$priceFieldBAO->id
]['tax_rate'] = $taxRate[$financialTypeId];
149 $getTaxDetails = TRUE;
151 if (isset($priceField[$priceFieldBAO->id
]['tax_rate'])) {
152 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($priceField[$priceFieldBAO->id
]['price'], $priceField[$priceFieldBAO->id
]['tax_rate'], TRUE);
153 $priceField[$priceFieldBAO->id
]['tax_amount'] = $taxAmount['tax_amount'];
157 $action = array_sum(array_keys(self
::actionLinks()));
159 if ($this->_isSetReserved
) {
160 $action -= CRM_Core_Action
::UPDATE + CRM_Core_Action
::DELETE + CRM_Core_Action
::ENABLE + CRM_Core_Action
::DISABLE
;
163 if ($priceFieldBAO->is_active
) {
164 $action -= CRM_Core_Action
::ENABLE
;
167 $action -= CRM_Core_Action
::DISABLE
;
171 if ($priceFieldBAO->active_on
== '0000-00-00 00:00:00') {
172 $priceField[$priceFieldBAO->id
]['active_on'] = '';
175 if ($priceFieldBAO->expire_on
== '0000-00-00 00:00:00') {
176 $priceField[$priceFieldBAO->id
]['expire_on'] = '';
179 // need to translate html types from the db
180 $htmlTypes = CRM_Price_BAO_PriceField
::htmlTypes();
181 $priceField[$priceFieldBAO->id
]['html_type_display'] = $htmlTypes[$priceField[$priceFieldBAO->id
]['html_type']];
182 $priceField[$priceFieldBAO->id
]['order'] = $priceField[$priceFieldBAO->id
]['weight'];
183 $priceField[$priceFieldBAO->id
]['action'] = CRM_Core_Action
::formLink(
187 'fid' => $priceFieldBAO->id
,
188 'sid' => $this->_sid
,
192 'priceField.row.actions',
196 $this->assign('taxTerm', $taxTerm);
197 $this->assign('getTaxDetails', $getTaxDetails);
200 $returnURL = CRM_Utils_System
::url('civicrm/admin/price/field', "reset=1&action=browse&sid={$this->_sid}");
201 $filter = "price_set_id = {$this->_sid}";
202 CRM_Utils_Weight
::addOrder($priceField, 'CRM_Price_DAO_PriceField',
203 'id', $returnURL, $filter
205 $this->assign('priceField', $priceField);
211 * editing would involved modifying existing fields + adding data to new fields.
213 * @param string $action
214 * The action to be invoked.
216 public function edit($action) {
217 // create a simple controller for editing price data
218 $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_Field', ts('Price Field'), $action);
220 // set the userContext stack
221 $session = CRM_Core_Session
::singleton();
222 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid
));
224 $controller->set('sid', $this->_sid
);
225 $controller->setEmbedded(TRUE);
226 $controller->process();
233 * This method is called after the page is created. It checks for the
234 * type of action and executes that action.
238 public function run() {
241 $this->_sid
= CRM_Utils_Request
::retrieve('sid', 'Positive',
244 $fid = CRM_Utils_Request
::retrieve('fid', 'Positive',
247 $action = CRM_Utils_Request
::retrieve('action', 'String',
248 // default to 'browse'
249 $this, FALSE, 'browse'
253 $usedBy = CRM_Price_BAO_PriceSet
::getUsedBy($this->_sid
);
254 $this->assign('usedBy', $usedBy);
255 $this->_isSetReserved
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid
, 'is_reserved');
256 $this->assign('isReserved', $this->_isSetReserved
);
258 CRM_Price_BAO_PriceSet
::checkPermission($this->_sid
);
260 'Event' => 'civicrm_event',
261 'Contribution' => 'civicrm_contribution_page',
262 'EventTemplate' => 'civicrm_event_template',
264 $priceSetContexts = array();
265 foreach ($comps as $name => $table) {
266 if (array_key_exists($table, $usedBy)) {
267 $priceSetContexts[] = $name;
270 $this->assign('contexts', $priceSetContexts);
273 if ($action & (CRM_Core_Action
::DELETE
) && !$this->_isSetReserved
) {
274 if (empty($usedBy)) {
276 $session = CRM_Core_Session
::singleton();
277 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid
));
278 $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_DeleteField', 'Delete Price Field', '');
279 $controller->set('fid', $fid);
280 $controller->setEmbedded(TRUE);
281 $controller->process();
286 $url = CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1');
287 CRM_Utils_System
::appendBreadCrumb(ts('Price'),
290 $this->assign('usedPriceSetTitle', CRM_Price_BAO_PriceField
::getTitle($fid));
294 if ($action & CRM_Core_Action
::DELETE
) {
295 CRM_Utils_System
::setTitle(ts('Delete Price Field'));
297 elseif ($this->_sid
) {
298 $groupTitle = CRM_Price_BAO_PriceSet
::getTitle($this->_sid
);
299 $this->assign('sid', $this->_sid
);
300 $this->assign('groupTitle', $groupTitle);
301 CRM_Utils_System
::setTitle(ts('%1 - Price Fields', array(1 => $groupTitle)));
304 // assign vars to templates
305 $this->assign('action', $action);
307 // what action to take ?
308 if ($action & (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD
) && !$this->_isSetReserved
) {
309 // no browse for edit/update/view
310 $this->edit($action);
312 elseif ($action & CRM_Core_Action
::PREVIEW
) {
313 $this->preview($fid);
319 // Call the parents run method
320 return parent
::run();
324 * Preview price field.
328 * @internal param int $id price field id
332 public function preview($fid) {
333 $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_Preview', ts('Preview Form Field'), CRM_Core_Action
::PREVIEW
);
334 $session = CRM_Core_Session
::singleton();
335 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid
));
336 $controller->set('fieldId', $fid);
337 $controller->set('groupId', $this->_sid
);
338 $controller->setEmbedded(TRUE);
339 $controller->process();