3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
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 Custom Options.
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_Option
extends CRM_Core_Page
{
46 public $useLivePageJS = TRUE;
49 * The field id of the option.
56 * The field id of the option.
63 * The price set is reserved or not.
67 protected $_isSetReserved = FALSE;
70 * The action links that we need to display for the browse screen.
74 private static $_actionLinks;
77 * Get the action links for this page.
80 * array of action links that we need to display for the browse screen
82 public static function &actionLinks() {
83 if (!isset(self
::$_actionLinks)) {
84 self
::$_actionLinks = array(
85 CRM_Core_Action
::UPDATE
=> array(
86 'name' => ts('Edit Option'),
87 'url' => 'civicrm/admin/price/field/option',
88 'qs' => 'reset=1&action=update&oid=%%oid%%&fid=%%fid%%&sid=%%sid%%',
89 'title' => ts('Edit Price Option'),
91 CRM_Core_Action
::VIEW
=> array(
93 'url' => 'civicrm/admin/price/field/option',
94 'qs' => 'action=view&oid=%%oid%%',
95 'title' => ts('View Price Option'),
97 CRM_Core_Action
::DISABLE
=> array(
98 'name' => ts('Disable'),
99 'ref' => 'crm-enable-disable',
100 'title' => ts('Disable Price Option'),
102 CRM_Core_Action
::ENABLE
=> array(
103 'name' => ts('Enable'),
104 'ref' => 'crm-enable-disable',
105 'title' => ts('Enable Price Option'),
107 CRM_Core_Action
::DELETE
=> array(
108 'name' => ts('Delete'),
109 'url' => 'civicrm/admin/price/field/option',
110 'qs' => 'action=delete&oid=%%oid%%',
111 'title' => ts('Disable Price Option'),
115 return self
::$_actionLinks;
119 * Browse all price fields.
123 public function browse() {
124 $priceOptions = civicrm_api3('PriceFieldValue', 'get', array(
125 'price_field_id' => $this->_fid
,
126 // Explicitly do not check permissions so we are not
127 // restricted by financial type, so we can change them.
128 'check_permissions' => FALSE,
131 'sort' => array('weight', 'label'),
134 $customOption = $priceOptions['values'];
136 // CRM-15378 - check if these price options are in an Event price set
138 $extendComponentId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid
, 'extends', 'id');
139 $allComponents = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $extendComponentId);
140 $eventComponentId = CRM_Core_Component
::getComponentID('CiviEvent');
141 if (in_array($eventComponentId, $allComponents)) {
145 $config = CRM_Core_Config
::singleton();
146 $taxRate = CRM_Core_PseudoConstant
::getTaxRates();
147 // display taxTerm for priceFields
148 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
149 $taxTerm = CRM_Utils_Array
::value('tax_term', $invoiceSettings);
150 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
151 $getTaxDetails = FALSE;
152 foreach ($customOption as $id => $values) {
153 $action = array_sum(array_keys(self
::actionLinks()));
154 // Adding the required fields in the array
155 if (isset($taxRate[$values['financial_type_id']])) {
156 // Cast to float so trailing zero decimals are removed
157 $customOption[$id]['tax_rate'] = (float) $taxRate[$values['financial_type_id']];
158 if ($invoicing && isset($customOption[$id]['tax_rate'])) {
159 $getTaxDetails = TRUE;
161 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($customOption[$id]['amount'], $customOption[$id]['tax_rate'], TRUE);
162 $customOption[$id]['tax_amount'] = $taxAmount['tax_amount'];
164 if (!empty($values['financial_type_id'])) {
165 $customOption[$id]['financial_type_id'] = CRM_Contribute_PseudoConstant
::financialType($values['financial_type_id']);
167 // update enable/disable links depending on price_field properties.
168 if ($this->_isSetReserved
) {
169 $action -= CRM_Core_Action
::UPDATE + CRM_Core_Action
::DELETE + CRM_Core_Action
::DISABLE + CRM_Core_Action
::ENABLE
;
172 if ($values['is_active']) {
173 $action -= CRM_Core_Action
::ENABLE
;
176 $action -= CRM_Core_Action
::DISABLE
;
179 if (!empty($customOption[$id]['is_default'])) {
180 $customOption[$id]['is_default'] = '<img src="' . $config->resourceBase
. 'i/check.gif" />';
183 $customOption[$id]['is_default'] = '';
185 $customOption[$id]['order'] = $customOption[$id]['weight'];
186 $customOption[$id]['action'] = CRM_Core_Action
::formLink(self
::actionLinks(), $action,
189 'fid' => $this->_fid
,
190 'sid' => $this->_sid
,
194 'priceFieldValue.row.actions',
199 // Add order changing widget to selector
200 $returnURL = CRM_Utils_System
::url('civicrm/admin/price/field/option', "action=browse&reset=1&fid={$this->_fid}&sid={$this->_sid}");
201 $filter = "price_field_id = {$this->_fid}";
202 CRM_Utils_Weight
::addOrder($customOption, 'CRM_Price_DAO_PriceFieldValue',
203 'id', $returnURL, $filter
206 $this->assign('taxTerm', $taxTerm);
207 $this->assign('getTaxDetails', $getTaxDetails);
208 $this->assign('customOption', $customOption);
209 $this->assign('sid', $this->_sid
);
210 $this->assign('isEvent', $isEvent);
214 * Edit custom Option.
216 * editing would involved modifying existing fields + adding data to new fields.
218 * @param string $action
219 * The action to be invoked.
223 public function edit($action) {
224 $oid = CRM_Utils_Request
::retrieve('oid', 'Positive',
229 $params['oid'] = $oid;
230 $sid = CRM_Price_BAO_PriceSet
::getSetId($params);
232 $usedBy = CRM_Price_BAO_PriceSet
::getUsedBy($sid);
234 // set the userContext stack
235 $session = CRM_Core_Session
::singleton();
237 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/price/field/option',
238 "reset=1&action=browse&fid={$this->_fid}&sid={$this->_sid}"
240 $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_Option', ts('Price Field Option'), $action);
241 $controller->set('fid', $this->_fid
);
242 $controller->setEmbedded(TRUE);
243 $controller->process();
246 if ($action & CRM_Core_Action
::DELETE
) {
248 $url = CRM_Utils_System
::url('civicrm/admin/price/field/option', 'reset=1');
249 CRM_Utils_System
::appendBreadCrumb(ts('Price Option'),
252 $this->assign('usedPriceSetTitle', CRM_Price_BAO_PriceFieldValue
::getOptionLabel($oid));
253 $this->assign('usedBy', $usedBy);
255 "Event" => "civicrm_event",
256 "Contribution" => "civicrm_contribution_page",
258 $priceSetContexts = array();
259 foreach ($comps as $name => $table) {
260 if (array_key_exists($table, $usedBy)) {
261 $priceSetContexts[] = $name;
264 $this->assign('contexts', $priceSetContexts);
271 * This method is called after the page is created. It checks for the
272 * type of action and executes that action.
276 public function run() {
278 $this->_fid
= CRM_Utils_Request
::retrieve('fid', 'Positive',
281 //get the price set id
283 $this->_sid
= CRM_Utils_Request
::retrieve('sid', 'Positive', $this);
287 CRM_Price_BAO_PriceSet
::checkPermission($this->_sid
);
288 $this->_isSetReserved
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid
, 'is_reserved');
289 $this->assign('isReserved', $this->_isSetReserved
);
291 //as url contain $sid so append breadcrumb dynamically.
294 'title' => ts('Price Fields'),
295 'url' => CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1&sid=' . $this->_sid
),
298 CRM_Utils_System
::appendBreadCrumb($breadcrumb);
301 $fieldTitle = CRM_Price_BAO_PriceField
::getTitle($this->_fid
);
302 $this->assign('fid', $this->_fid
);
303 $this->assign('fieldTitle', $fieldTitle);
304 CRM_Utils_System
::setTitle(ts('%1 - Price Options', array(1 => $fieldTitle)));
306 $htmlType = CRM_Core_DAO
::getFieldValue('CRM_Price_BAO_PriceField', $this->_fid
, 'html_type');
307 $this->assign('addMoreFields', TRUE);
308 //for text price field only single option present
309 if ($htmlType == 'Text') {
310 $this->assign('addMoreFields', FALSE);
314 // get the requested action
315 $action = CRM_Utils_Request
::retrieve('action', 'String',
316 // default to 'browse'
317 $this, FALSE, 'browse'
320 // assign vars to templates
321 $this->assign('action', $action);
323 $oid = CRM_Utils_Request
::retrieve('oid', 'Positive',
326 // what action to take ?
327 if ($action & (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD |
328 CRM_Core_Action
::VIEW | CRM_Core_Action
::DELETE
329 ) && !$this->_isSetReserved
331 // no browse for edit/update/view
332 $this->edit($action);
337 // Call the parents run method
338 return parent
::run();