3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * form to process actions on the field aspect of Price
39 class CRM_Price_Form_Field
extends CRM_Core_Form
{
42 * Constants for number of options for data types of multiple option.
44 const NUM_OPTION
= 15;
47 * The custom set id saved to the session for an update
54 * The field id, used when editing the field
61 * The extended component Id
65 protected $_extendComponentId;
68 * Variable is set if price set is used for membership
70 protected $_useForMember;
73 * Set variables up before form is built
75 public function preProcess() {
77 $this->_sid
= CRM_Utils_Request
::retrieve('sid', 'Positive', $this, FALSE, NULL, 'REQUEST');
78 $this->_fid
= CRM_Utils_Request
::retrieve('fid', 'Positive', $this, FALSE, NULL, 'REQUEST');
79 $url = CRM_Utils_System
::url('civicrm/admin/price/field', "reset=1&action=browse&sid={$this->_sid}");
80 $breadCrumb = array(array('title' => ts('Price Set Fields'), 'url' => $url));
82 $this->_extendComponentId
= array();
83 $extendComponentId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid
, 'extends', 'id');
84 if ($extendComponentId) {
85 $this->_extendComponentId
= explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $extendComponentId);
88 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
90 $this->setPageTitle(ts('Price Field'));
94 * Set default values for the form. Note that in edit/view mode
95 * the default values are retrieved from the database
98 * array of default values
100 public function setDefaultValues() {
102 // is it an edit operation ?
103 if (isset($this->_fid
)) {
104 $params = array('id' => $this->_fid
);
105 $this->assign('fid', $this->_fid
);
106 CRM_Price_BAO_PriceField
::retrieve($params, $defaults);
107 $this->_sid
= $defaults['price_set_id'];
109 // if text, retrieve price
110 if ($defaults['html_type'] == 'Text') {
111 $valueParams = array('price_field_id' => $this->_fid
);
113 CRM_Price_BAO_PriceFieldValue
::retrieve($valueParams, $defaults);
115 // fix the display of the monetary value, CRM-4038
116 $defaults['price'] = CRM_Utils_Money
::format($defaults['amount'], NULL, '%a');
119 if (!empty($defaults['active_on'])) {
120 list($defaults['active_on'],
121 $defaults['active_on_time']
122 ) = CRM_Utils_Date
::setDateDefaults($defaults['active_on'], 'activityDateTime');
125 if (!empty($defaults['expire_on'])) {
126 list($defaults['expire_on'],
127 $defaults['expire_on_time']
128 ) = CRM_Utils_Date
::setDateDefaults($defaults['expire_on'], 'activityDateTime');
132 $defaults['is_active'] = 1;
133 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
134 $defaults['option_status[' . $i . ']'] = 1;
135 $defaults['option_weight[' . $i . ']'] = $i;
139 if ($this->_action
& CRM_Core_Action
::ADD
) {
140 $fieldValues = array('price_set_id' => $this->_sid
);
141 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Price_DAO_PriceField', $fieldValues);
142 $defaults['options_per_line'] = 1;
143 $defaults['is_display_amounts'] = 1;
145 $enabledComponents = CRM_Core_Component
::getEnabledComponents();
146 $eventComponentId = NULL;
147 if (array_key_exists('CiviEvent', $enabledComponents)) {
148 $eventComponentId = CRM_Core_Component
::getComponentID('CiviEvent');
151 if (isset($this->_sid
) && $this->_action
== CRM_Core_Action
::ADD
) {
152 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid
, 'financial_type_id');
153 $defaults['financial_type_id'] = $financialTypeId;
154 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
155 $defaults['option_financial_type_id[' . $i . ']'] = $financialTypeId;
162 * Build the form object
164 public function buildQuickForm() {
165 // lets trim all the whitespace
166 $this->applyFilter('__ALL__', 'trim');
168 // add a hidden field to remember the price set id
169 // this get around the browser tab issue
170 $this->add('hidden', 'sid', $this->_sid
);
171 $this->add('hidden', 'fid', $this->_fid
);
174 $this->add('text', 'label', ts('Field Label'), CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceField', 'label'), TRUE);
177 $javascript = 'onchange="option_html_type(this.form)";';
179 $htmlTypes = CRM_Price_BAO_PriceField
::htmlTypes();
181 // Text box for Participant Count for a field
184 $financialType = CRM_Financial_BAO_FinancialType
::getIncomeFinancialType();
185 if (count($financialType)) {
186 $this->assign('financialType', $financialType);
188 $enabledComponents = CRM_Core_Component
::getEnabledComponents();
189 $eventComponentId = $memberComponentId = NULL;
190 if (array_key_exists('CiviEvent', $enabledComponents)) {
191 $eventComponentId = CRM_Core_Component
::getComponentID('CiviEvent');
193 if (array_key_exists('CiviMember', $enabledComponents)) {
194 $memberComponentId = CRM_Core_Component
::getComponentID('CiviMember');
197 $attributes = CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceFieldValue');
199 $this->add('select', 'financial_type_id',
200 ts('Financial Type'),
201 array(' ' => ts('- select -')) +
$financialType
204 $this->assign('useForMember', FALSE);
205 if (in_array($eventComponentId, $this->_extendComponentId
)) {
206 $this->add('text', 'count', ts('Participant Count'), $attributes['count']);
208 $this->addRule('count', ts('Participant Count should be a positive number'), 'positiveInteger');
210 $this->add('text', 'max_value', ts('Max Participants'), $attributes['max_value']);
211 $this->addRule('max_value', ts('Please enter a valid Max Participants.'), 'positiveInteger');
213 $this->assign('useForEvent', TRUE);
216 if (in_array($memberComponentId, $this->_extendComponentId
)) {
217 $this->_useForMember
= 1;
218 $this->assign('useForMember', $this->_useForMember
);
220 $this->assign('useForEvent', FALSE);
223 $sel = $this->add('select', 'html_type', ts('Input Field Type'),
224 $htmlTypes, TRUE, $javascript
227 // price (for text inputs)
228 $this->add('text', 'price', ts('Price'));
229 $this->registerRule('price', 'callback', 'money', 'CRM_Utils_Rule');
230 $this->addRule('price', ts('must be a monetary value'), 'money');
232 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
233 $this->freeze('html_type');
236 // form fields of Custom Option rows
237 $_showHide = new CRM_Core_ShowHideBlocks('', '');
239 for ($i = 1; $i <= self
::NUM_OPTION
; $i++
) {
241 //the show hide blocks
242 $showBlocks = 'optionField_' . $i;
244 $_showHide->addHide($showBlocks);
245 if ($i == self
::NUM_OPTION
) {
246 $_showHide->addHide('additionalOption');
250 $_showHide->addShow($showBlocks);
253 $attributes['label']['size'] = 25;
254 $this->add('text', 'option_label[' . $i . ']', ts('Label'), $attributes['label']);
257 $this->add('text', 'option_amount[' . $i . ']', ts('Amount'), $attributes['amount']);
258 $this->addRule('option_amount[' . $i . ']', ts('Please enter a valid amount for this field.'), 'money');
263 'option_financial_type_id[' . $i . ']',
264 ts('Financial Type'),
265 array('' => ts('- select -')) +
$financialType
267 if (in_array($eventComponentId, $this->_extendComponentId
)) {
269 $this->add('text', 'option_count[' . $i . ']', ts('Participant Count'), $attributes['count']);
270 $this->addRule('option_count[' . $i . ']', ts('Please enter a valid Participants Count.'), 'positiveInteger');
273 $this->add('text', 'option_max_value[' . $i . ']', ts('Max Participants'), $attributes['max_value']);
274 $this->addRule('option_max_value[' . $i . ']', ts('Please enter a valid Max Participants.'), 'positiveInteger');
277 //$this->add('textArea', 'option_description['.$i.']', ts('Description'), array('rows' => 1, 'cols' => 40 ));
279 elseif (in_array($memberComponentId, $this->_extendComponentId
)) {
280 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
281 $js = array('onchange' => "calculateRowValues( $i );");
283 $this->add('select', 'membership_type_id[' . $i . ']', ts('Membership Type'),
284 array('' => ' ') +
$membershipTypes, FALSE, $js
286 $this->add('text', 'membership_num_terms[' . $i . ']', ts('Number of Terms'), CRM_Utils_Array
::value('membership_num_terms', $attributes));
290 $this->add('text', 'option_weight[' . $i . ']', ts('Order'), $attributes['weight']);
293 $this->add('checkbox', 'option_status[' . $i . ']', ts('Active?'));
295 $defaultOption[$i] = $this->createElement('radio', NULL, NULL, NULL, $i);
297 //for checkbox handling of default option
298 $this->add('checkbox', "default_checkbox_option[$i]", NULL);
300 //default option selection
301 $this->addGroup($defaultOption, 'default_option');
302 $_showHide->addToTemplate();
304 // is_display_amounts
305 $this->add('checkbox', 'is_display_amounts', ts('Display Amount?'));
308 $this->add('text', 'weight', ts('Order'), CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceField', 'weight'), TRUE);
309 $this->addRule('weight', ts('is a numeric field'), 'numeric');
311 // checkbox / radio options per line
312 $this->add('text', 'options_per_line', ts('Options Per Line'));
313 $this->addRule('options_per_line', ts('must be a numeric value'), 'numeric');
315 // help post, mask, attributes, javascript ?
316 $this->add('textarea', 'help_post', ts('Field Help'),
317 CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceField', 'help_post')
321 $date_options = array(
322 'format' => 'dmY His',
323 'minYear' => date('Y') - 1,
324 'maxYear' => date('Y') +
5,
325 'addEmptyOption' => TRUE,
327 $this->addDateTime('active_on', ts('Active On'), FALSE, array('formatType' => 'activityDateTime'));
330 $this->addDateTime('expire_on', ts('Expire On'), FALSE, array('formatType' => 'activityDateTime'));
333 $this->add('checkbox', 'is_required', ts('Required?'));
336 $this->add('checkbox', 'is_active', ts('Active?'));
339 $this->addButtons(array(
342 'name' => ts('Save'),
347 'name' => ts('Save and New'),
352 'name' => ts('Cancel'),
357 $this->add('select', 'visibility_id', ts('Visibility'), CRM_Core_PseudoConstant
::visibility());
359 // add a form rule to check default value
360 $this->addFormRule(array('CRM_Price_Form_Field', 'formRule'), $this);
362 // if view mode pls freeze it with the done button.
363 if ($this->_action
& CRM_Core_Action
::VIEW
) {
365 $url = CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid
);
366 $this->addElement('button',
369 array('onclick' => "location.href='$url'")
375 * Global validation rules for the form
377 * @param array $fields
378 * Posted values of the form.
381 * @param CRM_Core_Form $form
384 * if errors then list of errors to be posted back to the form,
387 public static function formRule($fields, $files, $form) {
389 // all option fields are of type "money"
392 /** Check the option values entered
393 * Appropriate values are required for the selected datatype
394 * Incomplete row checking is also required.
396 if (($form->_action
& CRM_Core_Action
::ADD ||
$form->_action
& CRM_Core_Action
::UPDATE
) &&
397 $fields['html_type'] == 'Text' && $fields['price'] == NULL
399 $errors['price'] = ts('Price is a required field');
402 if (($form->_action
& CRM_Core_Action
::ADD ||
$form->_action
& CRM_Core_Action
::UPDATE
) &&
403 $fields['html_type'] == 'Text' && $fields['financial_type_id'] == ''
405 $errors['financial_type_id'] = ts('Financial Type is a required field');
408 //avoid the same price field label in Within PriceSet
409 $priceFieldLabel = new CRM_Price_DAO_PriceField();
410 $priceFieldLabel->label
= $fields['label'];
411 $priceFieldLabel->price_set_id
= $form->_sid
;
414 if ($priceFieldLabel->find(TRUE) && $form->_fid
!= $priceFieldLabel->id
) {
419 $errors['label'] = ts('Name already exists in Database.');
422 if ((is_numeric(CRM_Utils_Array
::value('count', $fields)) &&
423 CRM_Utils_Array
::value('count', $fields) == 0
425 (CRM_Utils_Array
::value('html_type', $fields) == 'Text')
427 $errors['count'] = ts('Participant Count must be greater than zero.');
430 if ($form->_action
& CRM_Core_Action
::ADD
) {
431 if ($fields['html_type'] != 'Text') {
433 $_flagOption = $_rowError = 0;
435 $_showHide = new CRM_Core_ShowHideBlocks('', '');
437 for ($index = 1; $index <= self
::NUM_OPTION
; $index++
) {
439 $noLabel = $noAmount = $noWeight = 1;
440 if (!empty($fields['option_label'][$index])) {
442 $duplicateIndex = CRM_Utils_Array
::key($fields['option_label'][$index],
443 $fields['option_label']
446 if ((!($duplicateIndex === FALSE)) &&
447 (!($duplicateIndex == $index))
449 $errors["option_label[{$index}]"] = ts('Duplicate label value');
453 if ($form->_useForMember
) {
454 if (!empty($fields['membership_type_id'][$index])) {
455 $memTypesIDS[] = $fields['membership_type_id'][$index];
459 // allow for 0 value.
460 if (!empty($fields['option_amount'][$index]) ||
461 strlen($fields['option_amount'][$index]) > 0
466 if (!empty($fields['option_weight'][$index])) {
468 $duplicateIndex = CRM_Utils_Array
::key($fields['option_weight'][$index],
469 $fields['option_weight']
472 if ((!($duplicateIndex === FALSE)) &&
473 (!($duplicateIndex == $index))
475 $errors["option_weight[{$index}]"] = ts('Duplicate weight value');
479 if (!$noLabel && !$noAmount && !empty($fields['option_financial_type_id']) && $fields['option_financial_type_id'][$index] == '' && $fields['html_type'] != 'Text') {
480 $errors["option_financial_type_id[{$index}]"] = ts('Financial Type is a Required field.');
482 if ($noLabel && !$noAmount) {
483 $errors["option_label[{$index}]"] = ts('Label cannot be empty.');
487 if (!$noLabel && $noAmount) {
488 $errors["option_amount[{$index}]"] = ts('Amount cannot be empty.');
492 if ($noLabel && $noAmount) {
496 elseif (!empty($fields['option_max_value'][$index]) &&
497 !empty($fields['option_count'][$index]) &&
498 ($fields['option_count'][$index] > $fields['option_max_value'][$index])
500 $errors["option_max_value[{$index}]"] = ts('Participant count can not be greater than max participants.');
504 $showBlocks = 'optionField_' . $index;
506 $_showHide->addShow($showBlocks);
510 if (!empty($_emptyRow)) {
511 $_showHide->addHide($showBlocks);
514 $_showHide->addShow($showBlocks);
516 if ($index == self
::NUM_OPTION
) {
517 $hideBlock = 'additionalOption';
518 $_showHide->addHide($hideBlock);
521 $_flagOption = $_emptyRow = 0;
524 if (!empty($memTypesIDS)) {
525 // check for checkboxes allowing user to select multiple memberships from same membership organization
526 if ($fields['html_type'] == 'CheckBox') {
527 $foundDuplicate = FALSE;
529 foreach ($memTypesIDS as $key => $val) {
530 $org = CRM_Member_BAO_MembershipType
::getMembershipTypeOrganization($val);
531 if (in_array($org[$val], $orgIds)) {
532 $foundDuplicate = TRUE;
535 $orgIds[$val] = $org[$val];
538 if ($foundDuplicate) {
539 $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.');
543 // CRM-10390 - Only one price field in a set can include auto-renew membership options
544 $foundAutorenew = FALSE;
545 foreach ($memTypesIDS as $key => $val) {
546 // see if any price field option values in this price field are for memberships with autorenew
547 $memTypeDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($val);
548 if (!empty($memTypeDetails['auto_renew'])) {
549 $foundAutorenew = TRUE;
554 if ($foundAutorenew) {
555 // if so, check for other fields in this price set which also have auto-renew membership options
556 $otherFieldAutorenew = CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($form->_sid
);
557 if ($otherFieldAutorenew) {
558 $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.');
562 $_showHide->addToTemplate();
564 if ($countemptyrows == 15) {
565 $errors['option_label[1]'] = $errors['option_amount[1]'] = ts('Label and value cannot be empty.');
569 elseif (!empty($fields['max_value']) &&
570 !empty($fields['count']) &&
571 ($fields['count'] > $fields['max_value'])
573 $errors['max_value'] = ts('Participant count can not be greater than max participants.');
576 // do not process if no option rows were submitted
577 if (empty($fields['option_amount']) && empty($fields['option_label'])) {
581 if (empty($fields['option_name'])) {
582 $fields['option_amount'] = array();
585 if (empty($fields['option_label'])) {
586 $fields['option_label'] = array();
590 return empty($errors) ?
TRUE : $errors;
596 public function postProcess() {
597 // store the submitted values in an array
598 $params = $this->controller
->exportValues('Field');
600 $params['name'] = CRM_Utils_String
::titleToVar($params['label']);
601 $params['is_display_amounts'] = CRM_Utils_Array
::value('is_display_amounts', $params, FALSE);
602 $params['is_required'] = CRM_Utils_Array
::value('is_required', $params, FALSE);
603 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
604 $params['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params, FALSE);
605 if (isset($params['active_on'])) {
606 $params['active_on'] = CRM_Utils_Date
::processDate($params['active_on'],
607 CRM_Utils_Array
::value('active_on_time', $params),
611 if (isset($params['expire_on'])) {
612 $params['expire_on'] = CRM_Utils_Date
::processDate($params['expire_on'],
613 CRM_Utils_Array
::value('expire_on_time', $params),
617 $params['visibility_id'] = CRM_Utils_Array
::value('visibility_id', $params, FALSE);
618 $params['count'] = CRM_Utils_Array
::value('count', $params, FALSE);
620 // need the FKEY - price set id
621 $params['price_set_id'] = $this->_sid
;
623 if ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD
)) {
624 $fieldValues = array('price_set_id' => $this->_sid
);
627 $oldWeight = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $this->_fid
, 'weight', 'id');
629 $params['weight'] = CRM_Utils_Weight
::updateOtherWeights('CRM_Price_DAO_PriceField', $oldWeight, $params['weight'], $fieldValues);
632 // make value <=> name consistency.
633 if (isset($params['option_name'])) {
634 $params['option_value'] = $params['option_name'];
636 $params['is_enter_qty'] = CRM_Utils_Array
::value('is_enter_qty', $params, FALSE);
638 if ($params['html_type'] == 'Text') {
639 // if html type is Text, force is_enter_qty on
640 $params['is_enter_qty'] = 1;
641 // modify params values as per the option group and option
643 $params['option_amount'] = array(1 => $params['price']);
644 $params['option_label'] = array(1 => $params['label']);
645 $params['option_count'] = array(1 => $params['count']);
646 $params['option_max_value'] = array(1 => CRM_Utils_Array
::value('max_value', $params));
647 //$params['option_description'] = array( 1 => $params['description'] );
648 $params['option_weight'] = array(1 => $params['weight']);
649 $params['option_financial_type_id'] = array(1 => $params['financial_type_id']);
650 $params['is_active'] = array(1 => 1);
654 $params['id'] = $this->_fid
;
657 $params['membership_num_terms'] = (!empty($params['membership_type_id'])) ? CRM_Utils_Array
::value('membership_num_terms', $params, 1) : NULL;
659 $priceField = CRM_Price_BAO_PriceField
::create($params);
661 if (!is_a($priceField, 'CRM_Core_Error')) {
662 CRM_Core_Session
::setStatus(ts('Price Field \'%1\' has been saved.', array(1 => $priceField->label
)), ts('Saved'), 'success');
664 $buttonName = $this->controller
->getButtonName();
665 $session = CRM_Core_Session
::singleton();
666 if ($buttonName == $this->getButtonName('next', 'new')) {
667 CRM_Core_Session
::setStatus(ts(' You can add another price set field.'), '', 'info');
668 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1&action=add&sid=' . $this->_sid
));
671 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid
));