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
35 * form to process actions on the field aspect of Price
37 class CRM_Price_Form_Field
extends CRM_Core_Form
{
40 * Constants for number of options for data types of multiple option.
42 const NUM_OPTION
= 15;
45 * The custom set id saved to the session for an update.
52 * The field id, used when editing the field
59 * The extended component Id.
63 protected $_extendComponentId;
66 * Variable is set if price set is used for membership.
68 protected $_useForMember;
71 * Set variables up before form is built.
73 public function preProcess() {
75 $this->_sid
= CRM_Utils_Request
::retrieve('sid', 'Positive', $this, FALSE, NULL, 'REQUEST');
76 $this->_fid
= CRM_Utils_Request
::retrieve('fid', 'Positive', $this, FALSE, NULL, 'REQUEST');
77 $url = CRM_Utils_System
::url('civicrm/admin/price/field', "reset=1&action=browse&sid={$this->_sid}");
78 $breadCrumb = array(array('title' => ts('Price Set Fields'), 'url' => $url));
80 $this->_extendComponentId
= array();
81 $extendComponentId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid
, 'extends', 'id');
82 if ($extendComponentId) {
83 $this->_extendComponentId
= explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $extendComponentId);
86 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
88 $this->setPageTitle(ts('Price Field'));
92 * Set default values for the form.
95 * array of default values
97 public function setDefaultValues() {
99 // is it an edit operation ?
100 if (isset($this->_fid
)) {
101 $params = array('id' => $this->_fid
);
102 $this->assign('fid', $this->_fid
);
103 CRM_Price_BAO_PriceField
::retrieve($params, $defaults);
104 $this->_sid
= $defaults['price_set_id'];
106 // if text, retrieve price
107 if ($defaults['html_type'] == 'Text') {
108 $isActive = $defaults['is_active'];
109 $valueParams = array('price_field_id' => $this->_fid
);
111 CRM_Price_BAO_PriceFieldValue
::retrieve($valueParams, $defaults);
113 // fix the display of the monetary value, CRM-4038
114 $defaults['price'] = CRM_Utils_Money
::format($defaults['amount'], NULL, '%a');
115 $defaults['is_active'] = $isActive;
120 $defaults['is_active'] = 1;
121 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
122 $defaults['option_status[' . $i . ']'] = 1;
123 $defaults['option_weight[' . $i . ']'] = $i;
124 $defaults['option_visibility_id[' . $i . ']'] = 1;
128 if ($this->_action
& CRM_Core_Action
::ADD
) {
129 $fieldValues = array('price_set_id' => $this->_sid
);
130 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Price_DAO_PriceField', $fieldValues);
131 $defaults['options_per_line'] = 1;
132 $defaults['is_display_amounts'] = 1;
134 $enabledComponents = CRM_Core_Component
::getEnabledComponents();
135 $eventComponentId = NULL;
136 if (array_key_exists('CiviEvent', $enabledComponents)) {
137 $eventComponentId = CRM_Core_Component
::getComponentID('CiviEvent');
140 if (isset($this->_sid
) && $this->_action
== CRM_Core_Action
::ADD
) {
141 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid
, 'financial_type_id');
142 $defaults['financial_type_id'] = $financialTypeId;
143 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
144 $defaults['option_financial_type_id[' . $i . ']'] = $financialTypeId;
151 * Build the form object.
153 public function buildQuickForm() {
154 // lets trim all the whitespace
155 $this->applyFilter('__ALL__', 'trim');
157 // add a hidden field to remember the price set id
158 // this get around the browser tab issue
159 $this->add('hidden', 'sid', $this->_sid
);
160 $this->add('hidden', 'fid', $this->_fid
);
163 $this->add('text', 'label', ts('Field Label'), CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceField', 'label'), TRUE);
166 $javascript = 'onchange="option_html_type(this.form)";';
168 $htmlTypes = CRM_Price_BAO_PriceField
::htmlTypes();
170 // Text box for Participant Count for a field
173 $financialType = CRM_Financial_BAO_FinancialType
::getIncomeFinancialType();
174 foreach ($financialType as $finTypeId => $type) {
175 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
176 && !CRM_Core_Permission
::check('add contributions of type ' . $type)
178 unset($financialType[$finTypeId]);
181 if (count($financialType)) {
182 $this->assign('financialType', $financialType);
185 //Visibility Type Options
186 $visibilityType = CRM_Core_PseudoConstant
::visibility();
187 $this->assign('visibilityType', $visibilityType);
189 $enabledComponents = CRM_Core_Component
::getEnabledComponents();
190 $eventComponentId = $memberComponentId = NULL;
191 if (array_key_exists('CiviEvent', $enabledComponents)) {
192 $eventComponentId = CRM_Core_Component
::getComponentID('CiviEvent');
194 if (array_key_exists('CiviMember', $enabledComponents)) {
195 $memberComponentId = CRM_Core_Component
::getComponentID('CiviMember');
198 $attributes = CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceFieldValue');
200 $this->add('select', 'financial_type_id',
201 ts('Financial Type'),
202 array(' ' => ts('- select -')) +
$financialType
205 $this->assign('useForMember', FALSE);
206 if (in_array($eventComponentId, $this->_extendComponentId
)) {
207 $this->add('text', 'count', ts('Participant Count'), $attributes['count']);
209 $this->addRule('count', ts('Participant Count should be a positive number'), 'positiveInteger');
211 $this->add('text', 'max_value', ts('Max Participants'), $attributes['max_value']);
212 $this->addRule('max_value', ts('Please enter a valid Max Participants.'), 'positiveInteger');
214 $this->assign('useForEvent', TRUE);
217 if (in_array($memberComponentId, $this->_extendComponentId
)) {
218 $this->_useForMember
= 1;
219 $this->assign('useForMember', $this->_useForMember
);
221 $this->assign('useForEvent', FALSE);
224 $sel = $this->add('select', 'html_type', ts('Input Field Type'),
225 $htmlTypes, TRUE, $javascript
228 // price (for text inputs)
229 $this->add('text', 'price', ts('Price'));
230 $this->registerRule('price', 'callback', 'money', 'CRM_Utils_Rule');
231 $this->addRule('price', ts('must be a monetary value'), 'money');
233 $this->add('text', 'non_deductible_amount', ts('Non-deductible Amount'), NULL);
234 $this->registerRule('non_deductible_amount', 'callback', 'money', 'CRM_Utils_Rule');
235 $this->addRule('non_deductible_amount', ts('Please enter a monetary value for this field.'), 'money');
237 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
238 $this->freeze('html_type');
241 // form fields of Custom Option rows
242 $_showHide = new CRM_Core_ShowHideBlocks('', '');
244 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
246 //the show hide blocks
247 $showBlocks = 'optionField_' . $i;
249 $_showHide->addHide($showBlocks);
250 if ($i == self
::NUM_OPTION
) {
251 $_showHide->addHide('additionalOption');
255 $_showHide->addShow($showBlocks);
258 $attributes['label']['size'] = 25;
259 $this->add('text', 'option_label[' . $i . ']', ts('Label'), $attributes['label']);
262 $this->add('text', 'option_amount[' . $i . ']', ts('Amount'), $attributes['amount']);
263 $this->addRule('option_amount[' . $i . ']', ts('Please enter a valid amount for this field.'), 'money');
268 'option_financial_type_id[' . $i . ']',
269 ts('Financial Type'),
270 array('' => ts('- select -')) +
$financialType
272 if (in_array($eventComponentId, $this->_extendComponentId
)) {
274 $this->add('text', 'option_count[' . $i . ']', ts('Participant Count'), $attributes['count']);
275 $this->addRule('option_count[' . $i . ']', ts('Please enter a valid Participants Count.'), 'positiveInteger');
278 $this->add('text', 'option_max_value[' . $i . ']', ts('Max Participants'), $attributes['max_value']);
279 $this->addRule('option_max_value[' . $i . ']', ts('Please enter a valid Max Participants.'), 'positiveInteger');
282 //$this->add('textArea', 'option_description['.$i.']', ts('Description'), array('rows' => 1, 'cols' => 40 ));
284 elseif (in_array($memberComponentId, $this->_extendComponentId
)) {
285 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
286 $js = array('onchange' => "calculateRowValues( $i );");
288 $this->add('select', 'membership_type_id[' . $i . ']', ts('Membership Type'),
289 array('' => ' ') +
$membershipTypes, FALSE, $js
291 $this->add('text', 'membership_num_terms[' . $i . ']', ts('Number of Terms'), CRM_Utils_Array
::value('membership_num_terms', $attributes));
295 $this->add('text', 'option_weight[' . $i . ']', ts('Order'), $attributes['weight']);
298 $this->add('checkbox', 'option_status[' . $i . ']', ts('Active?'));
300 $this->add('select', 'option_visibility_id[' . $i . ']', ts('Visibility'), $visibilityType);
301 $defaultOption[$i] = $this->createElement('radio', NULL, NULL, NULL, $i);
303 //for checkbox handling of default option
304 $this->add('checkbox', "default_checkbox_option[$i]", NULL);
306 //default option selection
307 $this->addGroup($defaultOption, 'default_option');
308 $_showHide->addToTemplate();
310 // is_display_amounts
311 $this->add('checkbox', 'is_display_amounts', ts('Display Amount?'));
314 $this->add('text', 'weight', ts('Order'), CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceField', 'weight'), TRUE);
315 $this->addRule('weight', ts('is a numeric field'), 'numeric');
317 // checkbox / radio options per line
318 $this->add('text', 'options_per_line', ts('Options Per Line'));
319 $this->addRule('options_per_line', ts('must be a numeric value'), 'numeric');
321 $this->add('textarea', 'help_pre', ts('Pre Field Help'),
322 CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceField', 'help_post')
325 // help post, mask, attributes, javascript ?
326 $this->add('textarea', 'help_post', ts('Post Field Help'),
327 CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceField', 'help_post')
330 $this->add('datepicker', 'active_on', ts('Active On'), [], FALSE, array('time' => TRUE));
333 $this->add('datepicker', 'expire_on', ts('Expire On'), [], FALSE, array('time' => TRUE));
336 $this->add('checkbox', 'is_required', ts('Required?'));
339 $this->add('checkbox', 'is_active', ts('Active?'));
342 $this->addButtons(array(
345 'name' => ts('Save'),
350 'name' => ts('Save and New'),
355 'name' => ts('Cancel'),
359 $this->add('select', 'visibility_id', ts('Visibility'), CRM_Core_PseudoConstant
::visibility());
361 // add a form rule to check default value
362 $this->addFormRule(array('CRM_Price_Form_Field', 'formRule'), $this);
364 // if view mode pls freeze it with the done button.
365 if ($this->_action
& CRM_Core_Action
::VIEW
) {
367 $url = CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid
);
368 $this->addElement('button',
371 array('onclick' => "location.href='$url'")
377 * Global validation rules for the form.
379 * @param array $fields
380 * Posted values of the form.
383 * @param CRM_Core_Form $form
386 * if errors then list of errors to be posted back to the form,
389 public static function formRule($fields, $files, $form) {
391 // all option fields are of type "money"
394 /** Check the option values entered
395 * Appropriate values are required for the selected datatype
396 * Incomplete row checking is also required.
398 if (($form->_action
& CRM_Core_Action
::ADD ||
$form->_action
& CRM_Core_Action
::UPDATE
) &&
399 $fields['html_type'] == 'Text'
401 if ($fields['price'] == NULL) {
402 $errors['price'] = ts('Price is a required field');
404 if ($fields['financial_type_id'] == '') {
405 $errors['financial_type_id'] = ts('Financial Type is a required field');
409 //avoid the same price field label in Within PriceSet
410 $priceFieldLabel = new CRM_Price_DAO_PriceField();
411 $priceFieldLabel->label
= $fields['label'];
412 $priceFieldLabel->price_set_id
= $form->_sid
;
415 if ($priceFieldLabel->find(TRUE) && $form->_fid
!= $priceFieldLabel->id
) {
420 $errors['label'] = ts('Name already exists in Database.');
423 if ((is_numeric(CRM_Utils_Array
::value('count', $fields)) &&
424 CRM_Utils_Array
::value('count', $fields) == 0
426 (CRM_Utils_Array
::value('html_type', $fields) == 'Text')
428 $errors['count'] = ts('Participant Count must be greater than zero.');
431 if ($form->_action
& CRM_Core_Action
::ADD
) {
432 if ($fields['html_type'] != 'Text') {
434 $publicOptionCount = $_flagOption = $_rowError = 0;
436 $_showHide = new CRM_Core_ShowHideBlocks('', '');
437 $visibilityOptions = CRM_Price_BAO_PriceFieldValue
::buildOptions('visibility_id', NULL, array('labelColumn' => 'name'));
439 for ($index = 1; $index <= self
::NUM_OPTION
; $index++
) {
441 $noLabel = $noAmount = $noWeight = 1;
442 if (!empty($fields['option_label'][$index])) {
444 $duplicateIndex = CRM_Utils_Array
::key($fields['option_label'][$index],
445 $fields['option_label']
448 if ((!($duplicateIndex === FALSE)) &&
449 (!($duplicateIndex == $index))
451 $errors["option_label[{$index}]"] = ts('Duplicate label value');
455 if ($form->_useForMember
) {
456 if (!empty($fields['membership_type_id'][$index])) {
457 $memTypesIDS[] = $fields['membership_type_id'][$index];
461 // allow for 0 value.
462 if (!empty($fields['option_amount'][$index]) ||
463 strlen($fields['option_amount'][$index]) > 0
468 if (!empty($fields['option_weight'][$index])) {
470 $duplicateIndex = CRM_Utils_Array
::key($fields['option_weight'][$index],
471 $fields['option_weight']
474 if ((!($duplicateIndex === FALSE)) &&
475 (!($duplicateIndex == $index))
477 $errors["option_weight[{$index}]"] = ts('Duplicate weight value');
481 if (!$noLabel && !$noAmount && !empty($fields['option_financial_type_id']) && $fields['option_financial_type_id'][$index] == '' && $fields['html_type'] != 'Text') {
482 $errors["option_financial_type_id[{$index}]"] = ts('Financial Type is a Required field.');
484 if ($noLabel && !$noAmount) {
485 $errors["option_label[{$index}]"] = ts('Label cannot be empty.');
489 if (!$noLabel && $noAmount) {
490 $errors["option_amount[{$index}]"] = ts('Amount cannot be empty.');
494 if ($noLabel && $noAmount) {
498 elseif (!empty($fields['option_max_value'][$index]) &&
499 !empty($fields['option_count'][$index]) &&
500 ($fields['option_count'][$index] > $fields['option_max_value'][$index])
502 $errors["option_max_value[{$index}]"] = ts('Participant count can not be greater than max participants.');
506 $showBlocks = 'optionField_' . $index;
508 $_showHide->addShow($showBlocks);
512 if (!empty($_emptyRow)) {
513 $_showHide->addHide($showBlocks);
516 $_showHide->addShow($showBlocks);
518 if ($index == self
::NUM_OPTION
) {
519 $hideBlock = 'additionalOption';
520 $_showHide->addHide($hideBlock);
523 if (!empty($fields['option_visibility_id'][$index]) && (!$noLabel ||
!$noAmount)) {
524 if ($visibilityOptions[$fields['option_visibility_id'][$index]] == 'public') {
525 $publicOptionCount++
;
529 $_flagOption = $_emptyRow = 0;
532 if (!empty($memTypesIDS)) {
533 // check for checkboxes allowing user to select multiple memberships from same membership organization
534 if ($fields['html_type'] == 'CheckBox') {
535 $foundDuplicate = FALSE;
537 foreach ($memTypesIDS as $key => $val) {
538 $org = CRM_Member_BAO_MembershipType
::getMembershipTypeOrganization($val);
539 if (in_array($org[$val], $orgIds)) {
540 $foundDuplicate = TRUE;
543 $orgIds[$val] = $org[$val];
546 if ($foundDuplicate) {
547 $errors['_qf_default'] = ts('You have selected multiple memberships for the same organization or entity. Please review your selections and choose only one membership per entity.');
551 // CRM-10390 - Only one price field in a set can include auto-renew membership options
552 $foundAutorenew = FALSE;
553 foreach ($memTypesIDS as $key => $val) {
554 // see if any price field option values in this price field are for memberships with autorenew
555 $memTypeDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($val);
556 if (!empty($memTypeDetails['auto_renew'])) {
557 $foundAutorenew = TRUE;
562 if ($foundAutorenew) {
563 // if so, check for other fields in this price set which also have auto-renew membership options
564 $otherFieldAutorenew = CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($form->_sid
);
565 if ($otherFieldAutorenew) {
566 $errors['_qf_default'] = ts('You can include auto-renew membership choices for only one price field in a price set. Another field in this set already contains one or more auto-renew membership options.');
570 $_showHide->addToTemplate();
572 if ($countemptyrows == 15) {
573 $errors['option_label[1]'] = $errors['option_amount[1]'] = ts('Label and value cannot be empty.');
577 if ($visibilityOptions[$fields['visibility_id']] == 'public' && $publicOptionCount == 0) {
578 $errors['visibility_id'] = ts('You have selected to make this field public but have not enabled any public price options. Please update your selections to include a public price option, or make this field admin visibility only.');
579 for ($index = 1; $index <= self
::NUM_OPTION
; $index++
) {
580 if (!empty($fields['option_label'][$index]) ||
!empty($fields['option_amount'][$index])) {
581 $errors["option_visibility_id[{$index}]"] = ts('Public field should at least have one public option.');
586 if ($visibilityOptions[$fields['visibility_id']] == 'admin' && $publicOptionCount > 0) {
587 $errors['visibility_id'] = ts('Field with \'Admin\' visibility should only contain \'Admin\' options.');
589 for ($index = 1; $index <= self
::NUM_OPTION
; $index++
) {
591 $isOptionSet = !empty($fields['option_label'][$index]) ||
!empty($fields['option_amount'][$index]);
592 $currentOptionVisibility = CRM_Utils_Array
::value($fields['option_visibility_id'][$index], $visibilityOptions);
594 if ($isOptionSet && $currentOptionVisibility == 'public') {
595 $errors["option_visibility_id[{$index}]"] = ts('\'Admin\' field should only have \'Admin\' visibility options.');
600 elseif (!empty($fields['max_value']) &&
601 !empty($fields['count']) &&
602 ($fields['count'] > $fields['max_value'])
604 $errors['max_value'] = ts('Participant count can not be greater than max participants.');
607 // do not process if no option rows were submitted
608 if (empty($fields['option_amount']) && empty($fields['option_label'])) {
612 if (empty($fields['option_name'])) {
613 $fields['option_amount'] = array();
616 if (empty($fields['option_label'])) {
617 $fields['option_label'] = array();
621 return empty($errors) ?
TRUE : $errors;
627 public function postProcess() {
628 // store the submitted values in an array
629 $params = $this->controller
->exportValues('Field');
631 $params['is_display_amounts'] = CRM_Utils_Array
::value('is_display_amounts', $params, FALSE);
632 $params['is_required'] = CRM_Utils_Array
::value('is_required', $params, FALSE);
633 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
634 $params['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params, FALSE);
635 $params['visibility_id'] = CRM_Utils_Array
::value('visibility_id', $params, FALSE);
636 $params['count'] = CRM_Utils_Array
::value('count', $params, FALSE);
638 // need the FKEY - price set id
639 $params['price_set_id'] = $this->_sid
;
641 if ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD
)) {
642 $fieldValues = array('price_set_id' => $this->_sid
);
645 $oldWeight = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $this->_fid
, 'weight', 'id');
647 $params['weight'] = CRM_Utils_Weight
::updateOtherWeights('CRM_Price_DAO_PriceField', $oldWeight, $params['weight'], $fieldValues);
650 // make value <=> name consistency.
651 if (isset($params['option_name'])) {
652 $params['option_value'] = $params['option_name'];
654 $params['is_enter_qty'] = CRM_Utils_Array
::value('is_enter_qty', $params, FALSE);
656 if ($params['html_type'] == 'Text') {
657 // if html type is Text, force is_enter_qty on
658 $params['is_enter_qty'] = 1;
659 // modify params values as per the option group and option
661 $params['option_amount'] = array(1 => $params['price']);
662 $params['option_label'] = array(1 => $params['label']);
663 $params['option_count'] = array(1 => $params['count']);
664 $params['option_max_value'] = array(1 => CRM_Utils_Array
::value('max_value', $params));
665 //$params['option_description'] = array( 1 => $params['description'] );
666 $params['option_weight'] = array(1 => $params['weight']);
667 $params['option_financial_type_id'] = array(1 => $params['financial_type_id']);
668 $params['option_visibility_id'] = array(1 => CRM_Utils_Array
::value('visibility_id', $params));
669 $params['is_active'] = array(1 => 1);
673 $params['id'] = $this->_fid
;
676 $params['membership_num_terms'] = (!empty($params['membership_type_id'])) ? CRM_Utils_Array
::value('membership_num_terms', $params, 1) : NULL;
678 $priceField = CRM_Price_BAO_PriceField
::create($params);
680 if (!is_a($priceField, 'CRM_Core_Error')) {
681 CRM_Core_Session
::setStatus(ts('Price Field \'%1\' has been saved.', array(1 => $priceField->label
)), ts('Saved'), 'success');
683 $buttonName = $this->controller
->getButtonName();
684 $session = CRM_Core_Session
::singleton();
685 if ($buttonName == $this->getButtonName('next', 'new')) {
686 CRM_Core_Session
::setStatus(ts(' You can add another price set field.'), '', 'info');
687 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1&action=add&sid=' . $this->_sid
));
690 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid
));