CRM/Admin/Form/Options.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2016
  32  */
  33
  34 /**
  35  * This class generates form components for Options.
  36  */
  37 class CRM_Admin_Form_Options extends CRM_Admin_Form {
  38
  39   /**
  40    * The option group name.
  41    *
  42    * @var array
  43    */
  44   protected $_gName;
  45
  46   /**
  47    * The option group name in display format (capitalized, without underscores...etc)
  48    *
  49    * @var array
  50    */
  51   protected $_gLabel;
  52
  53   /**
  54    * Pre-process
  55    */
  56   public function preProcess() {
  57     parent::preProcess();
  58     $session = CRM_Core_Session::singleton();
  59     if (!$this->_gName && !empty($this->urlPath[3])) {
  60       $this->_gName = $this->urlPath[3];
  61     }
  62     if (!$this->_gName && !empty($_GET['gid'])) {
  63       $this->_gName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', (int) $_GET['gid'], 'name');
  64     }
  65     if ($this->_gName) {
  66       $this->set('gName', $this->_gName);
  67     }
  68     else {
  69       $this->_gName = $this->get('gName');
  70     }
  71     $this->_gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup',
  72       $this->_gName,
  73       'id',
  74       'name'
  75     );
  76     $this->_gLabel = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $this->_gid, 'title');
  77     $url = "civicrm/admin/options/{$this->_gName}";
  78     $params = "reset=1";
  79
  80     if (($this->_action & CRM_Core_Action::DELETE) &&
  81       in_array($this->_gName, array('email_greeting', 'postal_greeting', 'addressee'))
  82     ) {
  83       // Don't allow delete if the option value belongs to addressee, postal or email greetings and is in use.
  84       $findValue = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'value');
  85       $queryParam = array(1 => array($findValue, 'Integer'));
  86       $columnName = $this->_gName . "_id";
  87       $sql = "SELECT count(id) FROM civicrm_contact WHERE " . $columnName . " = %1";
  88       $isInUse = CRM_Core_DAO::singleValueQuery($sql, $queryParam);
  89       if ($isInUse) {
  90         $scriptURL = "<a href='" . CRM_Utils_System::docURL2('Update Greetings and Address Data for Contacts', TRUE, NULL, NULL, NULL, "wiki") . "'>" . ts('Learn more about a script that can automatically update contact addressee and greeting options.') . "</a>";
  91         CRM_Core_Session::setStatus(ts('The selected %1 option has <strong>not been deleted</strong> because it is currently in use. Please update these contacts to use a different format before deleting this option. %2', array(
  92               1 => $this->_gLabel,
  93               2 => $scriptURL,
  94             )), ts('Sorry'), 'error');
  95         $redirect = CRM_Utils_System::url($url, $params);
  96         CRM_Utils_System::redirect($redirect);
  97       }
  98     }
  99
 100     $session->pushUserContext(CRM_Utils_System::url($url, $params));
 101     $this->assign('id', $this->_id);
 102
 103     if ($this->_id && in_array($this->_gName, CRM_Core_OptionGroup::$_domainIDGroups)) {
 104       $domainID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'domain_id', 'id');
 105       if (CRM_Core_Config::domainID() != $domainID) {
 106         CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
 107       }
 108     }
 109   }
 110
 111   /**
 112    * Set default values for the form.
 113    */
 114   public function setDefaultValues() {
 115     $defaults = parent::setDefaultValues();
 116
 117     // Default weight & value
 118     $fieldValues = array('option_group_id' => $this->_gid);
 119     foreach (array('weight', 'value') as $field) {
 120       if (empty($defaults[$field])) {
 121         $defaults[$field] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', $fieldValues, $field);
 122       }
 123     }
 124
 125     //setDefault of contact types for email greeting, postal greeting, addressee, CRM-4575
 126     if (in_array($this->_gName, array(
 127       'email_greeting',
 128       'postal_greeting',
 129       'addressee',
 130     ))) {
 131       $defaults['contactOptions'] = (CRM_Utils_Array::value('filter', $defaults)) ? $defaults['filter'] : NULL;
 132     }
 133     // CRM-11516
 134     if ($this->_gName == 'payment_instrument' && $this->_id) {
 135       $defaults['financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($this->_id, 'civicrm_option_value', 'financial_account_id');
 136     }
 137     return $defaults;
 138   }
 139
 140   /**
 141    * Build the form object.
 142    */
 143   public function buildQuickForm() {
 144     parent::buildQuickForm();
 145     $this->setPageTitle(ts('%1 Option', array(1 => $this->_gLabel)));
 146
 147     if ($this->_action & CRM_Core_Action::DELETE) {
 148       return;
 149     }
 150
 151     $this->applyFilter('__ALL__', 'trim');
 152
 153     $isReserved = FALSE;
 154     if ($this->_id) {
 155       $isReserved = (bool) CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'is_reserved');
 156     }
 157
 158     $this->add('text',
 159       'label',
 160       ts('Label'),
 161       CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'label'),
 162       TRUE
 163     );
 164
 165     if ($this->_gName != 'activity_type') {
 166       $this->add('text',
 167         'value',
 168         ts('Value'),
 169         CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'value'),
 170         TRUE
 171       );
 172     }
 173
 174     if (!in_array($this->_gName, array(
 175         'email_greeting',
 176         'postal_greeting',
 177         'addressee',
 178       )) && !$isReserved
 179     ) {
 180       $this->addRule('label',
 181         ts('This Label already exists in the database for this option group. Please select a different Value.'),
 182         'optionExists',
 183         array('CRM_Core_DAO_OptionValue', $this->_id, $this->_gid, 'label')
 184       );
 185     }
 186
 187     if ($this->_gName == 'case_status') {
 188       $classes = array(
 189         'Opened' => ts('Opened'),
 190         'Closed' => ts('Closed'),
 191       );
 192
 193       $grouping = $this->add('select',
 194         'grouping',
 195         ts('Status Class'),
 196         $classes
 197       );
 198       if ($isReserved) {
 199         $grouping->freeze();
 200       }
 201     }
 202     // CRM-11516
 203     if ($this->_gName == 'payment_instrument') {
 204       $accountType = CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name = 'Asset' ");
 205       $financialAccount = CRM_Contribute_PseudoConstant::financialAccount(NULL, key($accountType));
 206
 207       $this->add('select', 'financial_account_id', ts('Financial Account'),
 208         array('' => ts('- select -')) + $financialAccount,
 209         TRUE
 210       );
 211     }
 212
 213     $required = FALSE;
 214     if ($this->_gName == 'custom_search') {
 215       $required = TRUE;
 216     }
 217     elseif ($this->_gName == 'redaction_rule' || $this->_gName == 'engagement_index') {
 218       if ($this->_gName == 'redaction_rule') {
 219         $this->add('checkbox',
 220           'filter',
 221           ts('Regular Expression?')
 222         );
 223       }
 224     }
 225     if ($this->_gName == 'participant_listing') {
 226       $this->add('text',
 227         'description',
 228         ts('Description'),
 229         CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'description')
 230       );
 231     }
 232     else {
 233       // Hard-coding attributes here since description is still stored as varchar and not text in the schema. dgg
 234       $this->add('wysiwyg', 'description',
 235         ts('Description'),
 236         array('rows' => 4, 'cols' => 80),
 237         $required
 238       );
 239     }
 240
 241     if ($this->_gName == 'event_badge') {
 242       $this->add('text',
 243         'name',
 244         ts('Class Name'),
 245         CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'name')
 246       );
 247     }
 248
 249     $this->add('text',
 250       'weight',
 251       ts('Order'),
 252       CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'weight'),
 253       TRUE
 254     );
 255     $this->addRule('weight', ts('is a numeric field'), 'numeric');
 256
 257     // If CiviCase enabled AND "Add" mode OR "edit" mode for non-reserved activities, only allow user to pick Core or CiviCase component.
 258     // FIXME: Each component should define whether adding new activity types is allowed.
 259     $config = CRM_Core_Config::singleton();
 260     if ($this->_gName == 'activity_type' && in_array("CiviCase", $config->enableComponents) &&
 261       (($this->_action & CRM_Core_Action::ADD) || !$isReserved)
 262     ) {
 263       $caseID = CRM_Core_Component::getComponentID('CiviCase');
 264       $components = array('' => ts('Contacts AND Cases'), $caseID => ts('Cases Only'));
 265       $this->add('select',
 266         'component_id',
 267         ts('Component'),
 268         $components, FALSE
 269       );
 270     }
 271
 272     $enabled = $this->add('checkbox', 'is_active', ts('Enabled?'));
 273
 274     if ($isReserved) {
 275       $enabled->freeze();
 276     }
 277
 278     //fix for CRM-3552, CRM-4575
 279     $showIsDefaultGroups = array(
 280       'email_greeting',
 281       'postal_greeting',
 282       'addressee',
 283       'from_email_address',
 284       'case_status',
 285       'encounter_medium',
 286       'case_type',
 287       'payment_instrument',
 288       'communication_style',
 289       'soft_credit_type',
 290       'website_type',
 291     );
 292
 293     if (in_array($this->_gName, $showIsDefaultGroups)) {
 294       $this->assign('showDefault', TRUE);
 295       $this->add('checkbox', 'is_default', ts('Default Option?'));
 296     }
 297
 298     //get contact type for which user want to create a new greeting/addressee type, CRM-4575
 299     if (in_array($this->_gName, array(
 300         'email_greeting',
 301         'postal_greeting',
 302         'addressee',
 303       )) && !$isReserved
 304     ) {
 305       $values = array(
 306         1 => ts('Individual'),
 307         2 => ts('Household'),
 308         3 => ts('Organization'),
 309         4 => ts('Multiple Contact Merge'),
 310       );
 311       $this->add('select', 'contactOptions', ts('Contact Type'), array('' => '-select-') + $values, TRUE);
 312       $this->assign('showContactFilter', TRUE);
 313     }
 314
 315     if ($this->_gName == 'participant_status') {
 316       // For Participant Status options, expose the 'filter' field to track which statuses are "Counted", and the Visibility field
 317       $element = $this->add('checkbox', 'filter', ts('Counted?'));
 318       $this->add('select', 'visibility_id', ts('Visibility'), CRM_Core_PseudoConstant::visibility());
 319     }
 320     if ($this->_gName == 'participant_role') {
 321       // For Participant Role options, expose the 'filter' field to track which statuses are "Counted"
 322       $this->add('checkbox', 'filter', ts('Counted?'));
 323     }
 324
 325     $this->addFormRule(array('CRM_Admin_Form_Options', 'formRule'), $this);
 326   }
 327
 328   /**
 329    * Global form rule.
 330    *
 331    * @param array $fields
 332    *   The input form values.
 333    * @param array $files
 334    *   The uploaded files if any.
 335    * @param array $self
 336    *   Current form object.
 337    *
 338    * @return array
 339    *   array of errors / empty array.
 340    */
 341   public static function formRule($fields, $files, $self) {
 342     $errors = array();
 343     if ($self->_gName == 'case_status' && empty($fields['grouping'])) {
 344       $errors['grouping'] = ts('Status class is a required field');
 345     }
 346
 347     if (in_array($self->_gName, array(
 348           'email_greeting',
 349           'postal_greeting',
 350           'addressee',
 351         )) && empty($self->_defaultValues['is_reserved'])
 352     ) {
 353       $label = $fields['label'];
 354       $condition = " AND v.label = '{$label}' ";
 355       $values = CRM_Core_OptionGroup::values($self->_gName, FALSE, FALSE, FALSE, $condition, 'filter');
 356       $checkContactOptions = TRUE;
 357
 358       if ($self->_id && ($self->_defaultValues['contactOptions'] == $fields['contactOptions'])) {
 359         $checkContactOptions = FALSE;
 360       }
 361
 362       if ($checkContactOptions && in_array($fields['contactOptions'], $values)) {
 363         $errors['label'] = ts('This Label already exists in the database for the selected contact type.');
 364       }
 365     }
 366
 367     if ($self->_gName == 'from_email_address') {
 368       $formEmail = CRM_Utils_Mail::pluckEmailFromHeader($fields['label']);
 369       if (!CRM_Utils_Rule::email($formEmail)) {
 370         $errors['label'] = ts('Please enter a valid email address.');
 371       }
 372
 373       $formName = explode('"', $fields['label']);
 374       if (empty($formName[1]) || count($formName) != 3) {
 375         $errors['label'] = ts('Please follow the proper format for From Email Address');
 376       }
 377     }
 378
 379     $optionGroup = self::getOptionGroupDataType($self->_gName);
 380     if ($dataType) {
 381       $validate = CRM_Utils_Type::validate($fields['value'], $dataType, FALSE);
 382       if (!$validate) {
 383         CRM_Core_Session::setStatus(
 384           ts('Data Type of the value field for this option value does not match ' . $dataType),
 385           ts('Value field Data Type mismatch'));
 386       }
 387     }
 388     return $errors;
 389   }
 390
 391   /**
 392    * Get the DataType for a specified Option Group.
 393    *
 394    * @param string $optionGroupName name of the option group
 395    *
 396    * @return string|null
 397    */
 398   public static function getOptionGroupDataType($optionGroupName) {
 399     $optionGroup = civicrm_api3('OptionGroup', 'get', array(
 400       'sequential' => 1,
 401       'name' => $optionGroupName,
 402     ));
 403
 404     $dataType = CRM_Core_BAO_OptionGroup::getDataType($optionGroup['id']);
 405     return $dataType;
 406   }
 407
 408   /**
 409    * Process the form submission.
 410    */
 411   public function postProcess() {
 412     if ($this->_action & CRM_Core_Action::DELETE) {
 413       $fieldValues = array('option_group_id' => $this->_gid);
 414       $wt = CRM_Utils_Weight::delWeight('CRM_Core_DAO_OptionValue', $this->_id, $fieldValues);
 415
 416       if (CRM_Core_BAO_OptionValue::del($this->_id)) {
 417         if ($this->_gName == 'phone_type') {
 418           CRM_Core_BAO_Phone::setOptionToNull(CRM_Utils_Array::value('value', $this->_defaultValues));
 419         }
 420
 421         CRM_Core_Session::setStatus(ts('Selected %1 type has been deleted.', array(1 => $this->_gLabel)), ts('Record Deleted'), 'success');
 422       }
 423       else {
 424         CRM_Core_Session::setStatus(ts('Selected %1 type has not been deleted.', array(1 => $this->_gLabel)), ts('Sorry'), 'error');
 425         CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $fieldValues);
 426       }
 427     }
 428     else {
 429       $params = $ids = array();
 430       $params = $this->exportValues();
 431
 432       // allow multiple defaults within group.
 433       $allowMultiDefaults = array('email_greeting', 'postal_greeting', 'addressee', 'from_email_address');
 434       if (in_array($this->_gName, $allowMultiDefaults)) {
 435         if ($this->_gName == 'from_email_address') {
 436           $params['reset_default_for'] = array('domain_id' => CRM_Core_Config::domainID());
 437         }
 438         elseif ($filter = CRM_Utils_Array::value('contactOptions', $params)) {
 439           $params['filter'] = $filter;
 440           $params['reset_default_for'] = array('filter' => "0, " . $params['filter']);
 441         }
 442
 443         //make sure we should has to have space, CRM-6977
 444         if ($this->_gName == 'from_email_address') {
 445           $params['label'] = str_replace('"<', '" <', $params['label']);
 446         }
 447       }
 448
 449       // set value of filter if not present in params
 450       if ($this->_id && !array_key_exists('filter', $params)) {
 451         if ($this->_gName == 'participant_role') {
 452           $params['filter'] = 0;
 453         }
 454         else {
 455           $params['filter'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'filter', 'id');
 456         }
 457       }
 458
 459       $groupParams = array('name' => ($this->_gName));
 460       $optionValue = CRM_Core_OptionValue::addOptionValue($params, $groupParams, $this->_action, $this->_id);
 461
 462       // CRM-11516
 463       if (!empty($params['financial_account_id'])) {
 464         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
 465         $params = array(
 466           'entity_table' => 'civicrm_option_value',
 467           'entity_id' => $optionValue->id,
 468           'account_relationship' => $relationTypeId,
 469           'financial_account_id' => $params['financial_account_id'],
 470         );
 471         CRM_Financial_BAO_FinancialTypeAccount::add($params);
 472       }
 473
 474       CRM_Core_Session::setStatus(ts('The %1 \'%2\' has been saved.', array(
 475             1 => $this->_gLabel,
 476             2 => $optionValue->label,
 477           )), ts('Saved'), 'success');
 478     }
 479   }
 480
 481 }