CRM/Price/Form/Option.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * form to process actions on the field aspect of Custom
  20  */
  21 class CRM_Price_Form_Option extends CRM_Core_Form {
  22
  23   /**
  24    * The price field id saved to the session for an update.
  25    *
  26    * @var int
  27    */
  28   protected $_fid;
  29
  30   /**
  31    * Option value  id, used when editing the Option
  32    *
  33    * @var int
  34    */
  35   protected $_oid;
  36
  37   /**
  38    * Array of Money fields
  39    *
  40    * @var array
  41    */
  42   protected $_moneyFields = ['amount', 'non_deductible_amount'];
  43
  44   /**
  45    * Set variables up before form is built.
  46    *
  47    * @return void
  48    */
  49   public function preProcess() {
  50     $this->setPageTitle(ts('Price Option'));
  51     $this->_fid = CRM_Utils_Request::retrieve('fid', 'Positive',
  52       $this
  53     );
  54     $this->_oid = CRM_Utils_Request::retrieve('oid', 'Positive',
  55       $this
  56     );
  57   }
  58
  59   /**
  60    * Set default values for the form. Note that in edit/view mode
  61    * the default values are retrieved from the database
  62    *
  63    * @return array|void  array of default values
  64    */
  65   public function setDefaultValues() {
  66     if ($this->_action == CRM_Core_Action::DELETE) {
  67       return NULL;
  68     }
  69     $defaults = [];
  70
  71     if (isset($this->_oid)) {
  72       $params = ['id' => $this->_oid];
  73
  74       CRM_Price_BAO_PriceFieldValue::retrieve($params, $defaults);
  75
  76       // fix the display of the monetary value, CRM-4038
  77       foreach ($this->_moneyFields as $field) {
  78         $defaults[$field] = CRM_Utils_Money::format(CRM_Utils_Array::value($field, $defaults), NULL, '%a');
  79       }
  80     }
  81
  82     $memberComponentId = CRM_Core_Component::getComponentID('CiviMember');
  83     $extendComponentId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid, 'extends', 'id');
  84
  85     if (!isset($defaults['membership_num_terms']) && $memberComponentId == $extendComponentId) {
  86       $defaults['membership_num_terms'] = 1;
  87     }
  88     // set financial type used for price set to set default for new option
  89     if (!$this->_oid) {
  90       $defaults['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid, 'financial_type_id', 'id');
  91     }
  92     if (!isset($defaults['weight']) || !$defaults['weight']) {
  93       $fieldValues = ['price_field_id' => $this->_fid];
  94       $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Price_DAO_PriceFieldValue', $fieldValues);
  95       $defaults['is_active'] = 1;
  96     }
  97
  98     return $defaults;
  99   }
 100
 101   /**
 102    * Build the form object.
 103    *
 104    * @return void
 105    */
 106   public function buildQuickForm() {
 107     if ($this->_action == CRM_Core_Action::UPDATE) {
 108       $finTypeId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $this->_oid, 'financial_type_id');
 109       if (!CRM_Financial_BAO_FinancialType::checkPermissionToEditFinancialType($finTypeId)) {
 110         CRM_Core_Error::statusBounce(ts("You do not have permission to access this page"));
 111       }
 112     }
 113     if ($this->_action == CRM_Core_Action::DELETE) {
 114       $this->addButtons([
 115         [
 116           'type' => 'next',
 117           'name' => ts('Delete'),
 118         ],
 119         [
 120           'type' => 'cancel',
 121           'name' => ts('Cancel'),
 122         ],
 123       ]);
 124       return NULL;
 125     }
 126     else {
 127       $attributes = CRM_Core_DAO::getAttribute('CRM_Price_DAO_PriceFieldValue');
 128       // lets trim all the whitespace
 129       $this->applyFilter('__ALL__', 'trim');
 130
 131       // hidden Option Id for validation use
 132       $this->add('hidden', 'optionId', $this->_oid);
 133
 134       // Needed for i18n dialog
 135       $this->assign('optionId', $this->_oid);
 136
 137       //hidden field ID for validation use
 138       $this->add('hidden', 'fieldId', $this->_fid);
 139
 140       // label
 141       $this->add('text', 'label', ts('Option Label'), NULL, TRUE);
 142       $memberComponentId = CRM_Core_Component::getComponentID('CiviMember');
 143       if ($this->_action == CRM_Core_Action::UPDATE) {
 144         $this->_sid = CRM_Utils_Request::retrieve('sid', 'Positive', $this);
 145       }
 146       elseif ($this->_action == CRM_Core_Action::ADD ||
 147         $this->_action == CRM_Core_Action::VIEW
 148       ) {
 149         $this->_sid = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $this->_fid, 'price_set_id', 'id');
 150       }
 151       $this->isEvent = FALSE;
 152       $extendComponentId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid, 'extends', 'id');
 153       $this->assign('showMember', FALSE);
 154       if ($memberComponentId == $extendComponentId) {
 155         $this->assign('showMember', TRUE);
 156         $membershipTypes = CRM_Member_PseudoConstant::membershipType();
 157         $this->add('select', 'membership_type_id', ts('Membership Type'), [
 158           '' => ' ',
 159         ] + $membershipTypes, FALSE,
 160         ['onClick' => "calculateRowValues( );"]);
 161         $this->add('number', 'membership_num_terms', ts('Number of Terms'), $attributes['membership_num_terms']);
 162       }
 163       else {
 164         $allComponents = explode(CRM_Core_DAO::VALUE_SEPARATOR, $extendComponentId);
 165         $eventComponentId = CRM_Core_Component::getComponentID('CiviEvent');
 166         if (in_array($eventComponentId, $allComponents)) {
 167           $this->isEvent = TRUE;
 168           // count
 169           $this->add('number', 'count', ts('Participant Count'));
 170           $this->addRule('count', ts('Please enter a valid Max Participants.'), 'positiveInteger');
 171
 172           $this->add('number', 'max_value', ts('Max Participants'));
 173           $this->addRule('max_value', ts('Please enter a valid Max Participants.'), 'positiveInteger');
 174         }
 175
 176       }
 177       //Financial Type
 178       $financialType = CRM_Financial_BAO_FinancialType::getIncomeFinancialType();
 179
 180       if (count($financialType)) {
 181         $this->assign('financialType', $financialType);
 182       }
 183       $this->add(
 184         'select',
 185         'financial_type_id',
 186         ts('Financial Type'),
 187         ['' => ts('- select -')] + $financialType,
 188         TRUE
 189       );
 190
 191       //CRM_Core_DAO::getFieldValue( 'CRM_Price_DAO_PriceField', $this->_fid, 'weight', 'id' );
 192       // FIX ME: duplicate rule?
 193       /*
 194       $this->addRule( 'label',
 195       ts('Duplicate option label.'),
 196       'optionExists',
 197       array( 'CRM_Core_DAO_OptionValue', $this->_oid, $this->_ogId, 'label' ) );
 198        */
 199
 200       // value
 201       $this->add('text', 'amount', ts('Option Amount'), NULL, TRUE);
 202
 203       // the above value is used directly by QF, so the value has to be have a rule
 204       // please check with Lobo before u comment this
 205       $this->registerRule('amount', 'callback', 'money', 'CRM_Utils_Rule');
 206       $this->addRule('amount', ts('Please enter a monetary value for this field.'), 'money');
 207
 208       $this->add('text', 'non_deductible_amount', ts('Non-deductible Amount'), NULL);
 209       $this->registerRule('non_deductible_amount', 'callback', 'money', 'CRM_Utils_Rule');
 210       $this->addRule('non_deductible_amount', ts('Please enter a monetary value for this field.'), 'money');
 211
 212       $this->add('textarea', 'description', ts('Description'));
 213       $this->add('textarea', 'help_pre', ts('Pre Option Help'));
 214       $this->add('textarea', 'help_post', ts('Post Option Help'));
 215
 216       // weight
 217       $this->add('number', 'weight', ts('Order'), NULL, TRUE);
 218       $this->addRule('weight', ts('is a numeric field'), 'numeric');
 219
 220       // is active ?
 221       $this->add('checkbox', 'is_active', ts('Active?'));
 222
 223       // is public?
 224       $this->add('select', 'visibility_id', ts('Visibility'), CRM_Core_PseudoConstant::visibility());
 225
 226       //is default
 227       $this->add('checkbox', 'is_default', ts('Default'));
 228
 229       if ($this->_fid) {
 230         //hide the default checkbox option for text field
 231         $htmlType = CRM_Core_DAO::getFieldValue('CRM_Price_BAO_PriceField', $this->_fid, 'html_type');
 232         $this->assign('hideDefaultOption', FALSE);
 233         if ($htmlType == 'Text') {
 234           $this->assign('hideDefaultOption', TRUE);
 235         }
 236       }
 237       // add buttons
 238       $this->addButtons([
 239         [
 240           'type' => 'next',
 241           'name' => ts('Save'),
 242         ],
 243         [
 244           'type' => 'cancel',
 245           'name' => ts('Cancel'),
 246         ],
 247       ]);
 248
 249       // if view mode pls freeze it with the done button.
 250       if ($this->_action & CRM_Core_Action::VIEW) {
 251         $this->freeze();
 252         $this->addButtons([
 253           [
 254             'type' => 'cancel',
 255             'name' => ts('Done'),
 256             'isDefault' => TRUE,
 257           ],
 258         ]);
 259       }
 260     }
 261
 262     $this->addFormRule(['CRM_Price_Form_Option', 'formRule'], $this);
 263   }
 264
 265   /**
 266    * Global validation rules for the form.
 267    *
 268    * @param array $fields
 269    *   Posted values of the form.
 270    *
 271    * @param $files
 272    * @param CRM_Core_Form $form
 273    *
 274    * @return array
 275    *   if errors then list of errors to be posted back to the form,
 276    *                  true otherwise
 277    */
 278   public static function formRule($fields, $files, $form) {
 279     $errors = [];
 280     if (!empty($fields['count']) && !empty($fields['max_value']) &&
 281       $fields['count'] > $fields['max_value']
 282     ) {
 283       $errors['count'] = ts('Participant count can not be greater than max participants.');
 284     }
 285
 286     $priceField = CRM_Price_BAO_PriceField::findById($fields['fieldId']);
 287     $visibilityOptions = CRM_Core_PseudoConstant::get('CRM_Price_BAO_PriceFieldValue', 'visibility_id', ['labelColumn' => 'name']);
 288
 289     $publicCount = 0;
 290     $options = CRM_Price_BAO_PriceField::getOptions($priceField->id);
 291     foreach ($options as $currentOption) {
 292       if ($fields['optionId'] == $currentOption['id'] && $visibilityOptions[$fields['visibility_id']] == 'public') {
 293         $publicCount++;
 294       }
 295       elseif ($fields['optionId'] != $currentOption['id'] && $visibilityOptions[$currentOption['visibility_id']] == 'public') {
 296         $publicCount++;
 297       }
 298     }
 299     if ($visibilityOptions[$priceField->visibility_id] == 'public' && $publicCount == 0 && $visibilityOptions[$fields['visibility_id']] == 'admin') {
 300       $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.');
 301     }
 302     elseif ($visibilityOptions[$priceField->visibility_id] == 'admin' && $visibilityOptions[$fields['visibility_id']] == 'public') {
 303       $errors['visibility_id'] = ts('You must choose \'Admin\' visibility for this price option, as it belongs to a field with \'Admin\' visibility.');
 304     }
 305
 306     return empty($errors) ? TRUE : $errors;
 307   }
 308
 309   /**
 310    * Process the form.
 311    *
 312    * @return void
 313    */
 314   public function postProcess() {
 315     if ($this->_action == CRM_Core_Action::DELETE) {
 316       $fieldValues = ['price_field_id' => $this->_fid];
 317       $wt = CRM_Utils_Weight::delWeight('CRM_Price_DAO_PriceFieldValue', $this->_oid, $fieldValues);
 318       $label = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue',
 319         $this->_oid,
 320         'label', 'id'
 321       );
 322
 323       if (CRM_Price_BAO_PriceFieldValue::del($this->_oid)) {
 324         CRM_Core_Session::setStatus(ts('%1 option has been deleted.', [1 => $label]), ts('Record Deleted'), 'success');
 325       }
 326       return NULL;
 327     }
 328     else {
 329       $params = $ids = [];
 330       $params = $this->controller->exportValues('Option');
 331       $fieldLabel = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $this->_fid, 'label');
 332
 333       foreach ($this->_moneyFields as $field) {
 334         $params[$field] = CRM_Utils_Rule::cleanMoney(trim($params[$field]));
 335       }
 336       $params['price_field_id'] = $this->_fid;
 337       $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
 338       $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
 339       $params['visibility_id'] = CRM_Utils_Array::value('visibility_id', $params, FALSE);
 340       $ids = [];
 341       if ($this->_oid) {
 342         $params['id'] = $this->_oid;
 343       }
 344       $optionValue = CRM_Price_BAO_PriceFieldValue::create($params, $ids);
 345
 346       CRM_Core_Session::setStatus(ts("The option '%1' has been saved.", [1 => $params['label']]), ts('Value Saved'), 'success');
 347     }
 348   }
 349
 350 }