3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
21 * form to process actions on the field aspect of Custom
23 class CRM_Price_Form_Option
extends CRM_Core_Form
{
26 * The price field id saved to the session for an update.
33 * Option value id, used when editing the Option
40 * Array of Money fields
44 protected $_moneyFields = ['amount', 'non_deductible_amount'];
47 * Set variables up before form is built.
51 public function preProcess() {
52 $this->setPageTitle(ts('Price Option'));
53 $this->_fid
= CRM_Utils_Request
::retrieve('fid', 'Positive',
56 $this->_oid
= CRM_Utils_Request
::retrieve('oid', 'Positive',
62 * Set default values for the form. Note that in edit/view mode
63 * the default values are retrieved from the database
65 * @return array|void array of default values
67 public function setDefaultValues() {
68 if ($this->_action
== CRM_Core_Action
::DELETE
) {
73 if (isset($this->_oid
)) {
74 $params = ['id' => $this->_oid
];
76 CRM_Price_BAO_PriceFieldValue
::retrieve($params, $defaults);
78 // fix the display of the monetary value, CRM-4038
79 foreach ($this->_moneyFields
as $field) {
80 $defaults[$field] = CRM_Utils_Money
::format(CRM_Utils_Array
::value($field, $defaults), NULL, '%a');
84 $memberComponentId = CRM_Core_Component
::getComponentID('CiviMember');
85 $extendComponentId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid
, 'extends', 'id');
87 if (!isset($defaults['membership_num_terms']) && $memberComponentId == $extendComponentId) {
88 $defaults['membership_num_terms'] = 1;
90 // set financial type used for price set to set default for new option
92 $defaults['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid
, 'financial_type_id', 'id');
94 if (!isset($defaults['weight']) ||
!$defaults['weight']) {
95 $fieldValues = ['price_field_id' => $this->_fid
];
96 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Price_DAO_PriceFieldValue', $fieldValues);
97 $defaults['is_active'] = 1;
104 * Build the form object.
108 public function buildQuickForm() {
109 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
110 $finTypeId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $this->_oid
, 'financial_type_id');
111 if (!CRM_Financial_BAO_FinancialType
::checkPermissionToEditFinancialType($finTypeId)) {
112 CRM_Core_Error
::statusBounce(ts("You do not have permission to access this page"));
115 if ($this->_action
== CRM_Core_Action
::DELETE
) {
119 'name' => ts('Delete'),
123 'name' => ts('Cancel'),
129 $attributes = CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceFieldValue');
130 // lets trim all the whitespace
131 $this->applyFilter('__ALL__', 'trim');
133 // hidden Option Id for validation use
134 $this->add('hidden', 'optionId', $this->_oid
);
136 // Needed for i18n dialog
137 $this->assign('optionId', $this->_oid
);
139 //hidden field ID for validation use
140 $this->add('hidden', 'fieldId', $this->_fid
);
143 $this->add('text', 'label', ts('Option Label'), NULL, TRUE);
144 $memberComponentId = CRM_Core_Component
::getComponentID('CiviMember');
145 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
146 $this->_sid
= CRM_Utils_Request
::retrieve('sid', 'Positive', $this);
148 elseif ($this->_action
== CRM_Core_Action
::ADD ||
149 $this->_action
== CRM_Core_Action
::VIEW
151 $this->_sid
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $this->_fid
, 'price_set_id', 'id');
153 $this->isEvent
= FALSE;
154 $extendComponentId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid
, 'extends', 'id');
155 $this->assign('showMember', FALSE);
156 if ($memberComponentId == $extendComponentId) {
157 $this->assign('showMember', TRUE);
158 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
159 $this->add('select', 'membership_type_id', ts('Membership Type'), [
161 ] +
$membershipTypes, FALSE,
162 ['onClick' => "calculateRowValues( );"]);
163 $this->add('number', 'membership_num_terms', ts('Number of Terms'), $attributes['membership_num_terms']);
166 $allComponents = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $extendComponentId);
167 $eventComponentId = CRM_Core_Component
::getComponentID('CiviEvent');
168 if (in_array($eventComponentId, $allComponents)) {
169 $this->isEvent
= TRUE;
171 $this->add('number', 'count', ts('Participant Count'));
172 $this->addRule('count', ts('Please enter a valid Max Participants.'), 'positiveInteger');
174 $this->add('number', 'max_value', ts('Max Participants'));
175 $this->addRule('max_value', ts('Please enter a valid Max Participants.'), 'positiveInteger');
180 $financialType = CRM_Financial_BAO_FinancialType
::getIncomeFinancialType();
182 if (count($financialType)) {
183 $this->assign('financialType', $financialType);
188 ts('Financial Type'),
189 ['' => ts('- select -')] +
$financialType,
193 //CRM_Core_DAO::getFieldValue( 'CRM_Price_DAO_PriceField', $this->_fid, 'weight', 'id' );
194 // FIX ME: duplicate rule?
196 $this->addRule( 'label',
197 ts('Duplicate option label.'),
199 array( 'CRM_Core_DAO_OptionValue', $this->_oid, $this->_ogId, 'label' ) );
203 $this->add('text', 'amount', ts('Option Amount'), NULL, TRUE);
205 // the above value is used directly by QF, so the value has to be have a rule
206 // please check with Lobo before u comment this
207 $this->registerRule('amount', 'callback', 'money', 'CRM_Utils_Rule');
208 $this->addRule('amount', ts('Please enter a monetary value for this field.'), 'money');
210 $this->add('text', 'non_deductible_amount', ts('Non-deductible Amount'), NULL);
211 $this->registerRule('non_deductible_amount', 'callback', 'money', 'CRM_Utils_Rule');
212 $this->addRule('non_deductible_amount', ts('Please enter a monetary value for this field.'), 'money');
214 $this->add('textarea', 'description', ts('Description'));
215 $this->add('textarea', 'help_pre', ts('Pre Option Help'));
216 $this->add('textarea', 'help_post', ts('Post Option Help'));
219 $this->add('number', 'weight', ts('Order'), NULL, TRUE);
220 $this->addRule('weight', ts('is a numeric field'), 'numeric');
223 $this->add('checkbox', 'is_active', ts('Active?'));
226 $this->add('select', 'visibility_id', ts('Visibility'), CRM_Core_PseudoConstant
::visibility());
229 $this->add('checkbox', 'is_default', ts('Default'));
232 //hide the default checkbox option for text field
233 $htmlType = CRM_Core_DAO
::getFieldValue('CRM_Price_BAO_PriceField', $this->_fid
, 'html_type');
234 $this->assign('hideDefaultOption', FALSE);
235 if ($htmlType == 'Text') {
236 $this->assign('hideDefaultOption', TRUE);
243 'name' => ts('Save'),
247 'name' => ts('Cancel'),
251 // if view mode pls freeze it with the done button.
252 if ($this->_action
& CRM_Core_Action
::VIEW
) {
257 'name' => ts('Done'),
264 $this->addFormRule(['CRM_Price_Form_Option', 'formRule'], $this);
268 * Global validation rules for the form.
270 * @param array $fields
271 * Posted values of the form.
274 * @param CRM_Core_Form $form
277 * if errors then list of errors to be posted back to the form,
280 public static function formRule($fields, $files, $form) {
282 if (!empty($fields['count']) && !empty($fields['max_value']) &&
283 $fields['count'] > $fields['max_value']
285 $errors['count'] = ts('Participant count can not be greater than max participants.');
288 $priceField = CRM_Price_BAO_PriceField
::findById($fields['fieldId']);
289 $visibilityOptions = CRM_Core_PseudoConstant
::get('CRM_Price_BAO_PriceFieldValue', 'visibility_id', ['labelColumn' => 'name']);
292 $options = CRM_Price_BAO_PriceField
::getOptions($priceField->id
);
293 foreach ($options as $currentOption) {
294 if ($fields['optionId'] == $currentOption['id'] && $visibilityOptions[$fields['visibility_id']] == 'public') {
297 elseif ($fields['optionId'] != $currentOption['id'] && $visibilityOptions[$currentOption['visibility_id']] == 'public') {
301 if ($visibilityOptions[$priceField->visibility_id
] == 'public' && $publicCount == 0 && $visibilityOptions[$fields['visibility_id']] == 'admin') {
302 $errors['visibility_id'] = ts('All other options for this \'Public\' field have \'Admin\' visibility. There should at least be one \'Public\' option, or make the field \'Admin\' only.');
304 elseif ($visibilityOptions[$priceField->visibility_id
] == 'admin' && $visibilityOptions[$fields['visibility_id']] == 'public') {
305 $errors['visibility_id'] = ts('You must choose \'Admin\' visibility for this price option, as it belongs to a field with \'Admin\' visibility.');
308 return empty($errors) ?
TRUE : $errors;
316 public function postProcess() {
317 if ($this->_action
== CRM_Core_Action
::DELETE
) {
318 $fieldValues = ['price_field_id' => $this->_fid
];
319 $wt = CRM_Utils_Weight
::delWeight('CRM_Price_DAO_PriceFieldValue', $this->_oid
, $fieldValues);
320 $label = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue',
325 if (CRM_Price_BAO_PriceFieldValue
::del($this->_oid
)) {
326 CRM_Core_Session
::setStatus(ts('%1 option has been deleted.', [1 => $label]), ts('Record Deleted'), 'success');
332 $params = $this->controller
->exportValues('Option');
333 $fieldLabel = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $this->_fid
, 'label');
335 foreach ($this->_moneyFields
as $field) {
336 $params[$field] = CRM_Utils_Rule
::cleanMoney(trim($params[$field]));
338 $params['price_field_id'] = $this->_fid
;
339 $params['is_default'] = CRM_Utils_Array
::value('is_default', $params, FALSE);
340 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
341 $params['visibility_id'] = CRM_Utils_Array
::value('visibility_id', $params, FALSE);
344 $params['id'] = $this->_oid
;
346 $optionValue = CRM_Price_BAO_PriceFieldValue
::create($params, $ids);
348 CRM_Core_Session
::setStatus(ts("The option '%1' has been saved.", [1 => $params['label']]), ts('Value Saved'), 'success');