3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * This class generates form components for Options.
37 class CRM_Admin_Form_Options
extends CRM_Admin_Form
{
40 * The option group name.
47 * The option group name in display format (capitalized, without underscores...etc)
54 * Is this Option Group Domain Specific
57 protected $_domainSpecific = FALSE;
62 public function preProcess() {
64 $session = CRM_Core_Session
::singleton();
65 if (!$this->_gName
&& !empty($this->urlPath
[3])) {
66 $this->_gName
= $this->urlPath
[3];
68 if (!$this->_gName
&& !empty($_GET['gid'])) {
69 $this->_gName
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', (int) $_GET['gid'], 'name');
72 $this->set('gName', $this->_gName
);
75 $this->_gName
= $this->get('gName');
77 $this->_gid
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
82 $this->_gLabel
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', $this->_gid
, 'title');
83 $this->_domainSpecific
= in_array($this->_gName
, CRM_Core_OptionGroup
::$_domainIDGroups);
84 $url = "civicrm/admin/options/{$this->_gName}";
87 if (($this->_action
& CRM_Core_Action
::DELETE
) &&
88 in_array($this->_gName
, ['email_greeting', 'postal_greeting', 'addressee'])
90 // Don't allow delete if the option value belongs to addressee, postal or email greetings and is in use.
91 $findValue = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'value');
92 $queryParam = [1 => [$findValue, 'Integer']];
93 $columnName = $this->_gName
. "_id";
94 $sql = "SELECT count(id) FROM civicrm_contact WHERE " . $columnName . " = %1";
95 $isInUse = CRM_Core_DAO
::singleValueQuery($sql, $queryParam);
97 $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>";
98 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', [
101 ]), ts('Sorry'), 'error');
102 $redirect = CRM_Utils_System
::url($url, $params);
103 CRM_Utils_System
::redirect($redirect);
107 $session->pushUserContext(CRM_Utils_System
::url($url, $params));
108 $this->assign('id', $this->_id
);
110 if ($this->_id
&& in_array($this->_gName
, CRM_Core_OptionGroup
::$_domainIDGroups)) {
111 $domainID = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'domain_id', 'id');
112 if (CRM_Core_Config
::domainID() != $domainID) {
113 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
119 * Set default values for the form.
121 public function setDefaultValues() {
122 $defaults = parent
::setDefaultValues();
124 // Default weight & value
125 $fieldValues = ['option_group_id' => $this->_gid
];
126 foreach (['weight', 'value'] as $field) {
127 if (empty($defaults[$field])) {
128 $defaults[$field] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $fieldValues, $field);
132 // setDefault of contact types for email greeting, postal greeting, addressee, CRM-4575
133 if (in_array($this->_gName
, [
138 $defaults['contactOptions'] = (CRM_Utils_Array
::value('filter', $defaults)) ?
$defaults['filter'] : NULL;
141 if ($this->_gName
== 'payment_instrument' && $this->_id
) {
142 $defaults['financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($this->_id
, NULL, 'civicrm_option_value');
144 if (empty($this->_id
) ||
!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'color')) {
145 $defaults['color'] = '#ffffff';
151 * Build the form object.
153 public function buildQuickForm() {
154 parent
::buildQuickForm();
155 $this->setPageTitle(ts('%1 Option', [1 => $this->_gLabel
]));
157 if ($this->_action
& CRM_Core_Action
::DELETE
) {
161 $this->applyFilter('__ALL__', 'trim');
165 $isReserved = (bool) CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'is_reserved');
171 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'label'),
175 if ($this->_gName
!= 'activity_type') {
179 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'value'),
182 $this->addRule('value',
183 ts('This Value already exists in the database for this option group. Please select a different Value.'),
185 ['CRM_Core_DAO_OptionValue', $this->_id
, $this->_gid
, 'value', $this->_domainSpecific
]
189 $this->add('text', 'icon', ts('Icon'), ['class' => 'crm-icon-picker', 'title' => ts('Choose Icon'), 'allowClear' => TRUE]);
192 if (in_array($this->_gName
, ['activity_status', 'case_status'])) {
193 $this->add('color', 'color', ts('Color'));
196 if (!in_array($this->_gName
, ['email_greeting', 'postal_greeting', 'addressee'])
199 $this->addRule('label',
200 ts('This Label already exists in the database for this option group. Please select a different Label.'),
202 ['CRM_Core_DAO_OptionValue', $this->_id
, $this->_gid
, 'label', $this->_domainSpecific
]
206 if ($this->_gName
== 'case_status') {
208 'Opened' => ts('Opened'),
209 'Closed' => ts('Closed'),
212 $grouping = $this->add('select',
222 if ($this->_gName
== 'payment_instrument') {
223 $accountType = CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name = 'Asset' ");
224 $financialAccount = CRM_Contribute_PseudoConstant
::financialAccount(NULL, key($accountType));
226 $this->add('select', 'financial_account_id', ts('Financial Account'),
227 ['' => ts('- select -')] +
$financialAccount,
232 if ($this->_gName
== 'activity_status') {
237 CRM_Activity_BAO_Activity
::INCOMPLETE
=> ts('Incomplete'),
238 CRM_Activity_BAO_Activity
::COMPLETED
=> ts('Completed'),
239 CRM_Activity_BAO_Activity
::CANCELLED
=> ts('Cancelled'),
243 if ($this->_gName
== 'redaction_rule') {
244 $this->add('checkbox',
246 ts('Regular Expression?')
249 if ($this->_gName
== 'participant_listing') {
253 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'description')
257 // Hard-coding attributes here since description is still stored as varchar and not text in the schema. dgg
258 $this->add('wysiwyg', 'description',
260 ['rows' => 4, 'cols' => 80],
261 $this->_gName
== 'custom_search'
265 if ($this->_gName
== 'event_badge') {
269 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'name')
276 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'weight'),
279 $this->addRule('weight', ts('is a numeric field'), 'numeric');
281 // If CiviCase enabled AND "Add" mode OR "edit" mode for non-reserved activities, only allow user to pick Core or CiviCase component.
282 // FIXME: Each component should define whether adding new activity types is allowed.
283 $config = CRM_Core_Config
::singleton();
284 if ($this->_gName
== 'activity_type' && in_array("CiviCase", $config->enableComponents
) &&
285 (($this->_action
& CRM_Core_Action
::ADD
) ||
!$isReserved)
287 $caseID = CRM_Core_Component
::getComponentID('CiviCase');
288 $components = ['' => ts('Contacts AND Cases'), $caseID => ts('Cases Only')];
296 $enabled = $this->add('checkbox', 'is_active', ts('Enabled?'));
302 // fix for CRM-3552, CRM-4575
303 $showIsDefaultGroups = [
307 'from_email_address',
311 'payment_instrument',
312 'communication_style',
317 if (in_array($this->_gName
, $showIsDefaultGroups)) {
318 $this->assign('showDefault', TRUE);
319 $this->add('checkbox', 'is_default', ts('Default Option?'));
322 // get contact type for which user want to create a new greeting/addressee type, CRM-4575
323 if (in_array($this->_gName
, ['email_greeting', 'postal_greeting', 'addressee'])
327 1 => ts('Individual'),
328 2 => ts('Household'),
329 3 => ts('Organization'),
330 4 => ts('Multiple Contact Merge'),
332 $this->add('select', 'contactOptions', ts('Contact Type'), ['' => '-select-'] +
$values, TRUE);
333 $this->assign('showContactFilter', TRUE);
336 if ($this->_gName
== 'participant_status') {
337 // For Participant Status options, expose the 'filter' field to track which statuses are "Counted", and the Visibility field
338 $this->add('checkbox', 'filter', ts('Counted?'));
339 $this->add('select', 'visibility_id', ts('Visibility'), CRM_Core_PseudoConstant
::visibility());
341 if ($this->_gName
== 'participant_role') {
342 // For Participant Role options, expose the 'filter' field to track which statuses are "Counted"
343 $this->add('checkbox', 'filter', ts('Counted?'));
346 $this->addFormRule(['CRM_Admin_Form_Options', 'formRule'], $this);
352 * @param array $fields
353 * The input form values.
354 * @param array $files
355 * The uploaded files if any.
357 * Current form object.
360 * array of errors / empty array.
361 * @throws \CRM_Core_Exception
363 public static function formRule($fields, $files, $self) {
365 if ($self->_gName
== 'case_status' && empty($fields['grouping'])) {
366 $errors['grouping'] = ts('Status class is a required field');
369 if (in_array($self->_gName
, ['email_greeting', 'postal_greeting', 'addressee'])
370 && empty($self->_defaultValues
['is_reserved'])
372 $label = $fields['label'];
373 $condition = " AND v.label = '{$label}' ";
374 $values = CRM_Core_OptionGroup
::values($self->_gName
, FALSE, FALSE, FALSE, $condition, 'filter');
375 $checkContactOptions = TRUE;
377 if ($self->_id
&& ($self->_defaultValues
['contactOptions'] == $fields['contactOptions'])) {
378 $checkContactOptions = FALSE;
381 if ($checkContactOptions && in_array($fields['contactOptions'], $values)) {
382 $errors['label'] = ts('This Label already exists in the database for the selected contact type.');
386 if ($self->_gName
== 'from_email_address') {
387 $formEmail = CRM_Utils_Mail
::pluckEmailFromHeader($fields['label']);
388 if (!CRM_Utils_Rule
::email($formEmail)) {
389 $errors['label'] = ts('Please enter a valid email address.');
392 $formName = explode('"', $fields['label']);
393 if (empty($formName[1]) ||
count($formName) != 3) {
394 $errors['label'] = ts('Please follow the proper format for From Email Address');
398 $dataType = self
::getOptionGroupDataType($self->_gName
);
399 if ($dataType && $self->_gName
!== 'activity_type') {
400 $validate = CRM_Utils_Type
::validate($fields['value'], $dataType, FALSE);
401 if ($validate === FALSE) {
402 CRM_Core_Session
::setStatus(
403 ts('Data Type of the value field for this option value does not match %1.', [1 => $dataType]),
404 ts('Value field Data Type mismatch'));
411 * Get the DataType for a specified Option Group.
413 * @param string $optionGroupName name of the option group
415 * @return string|null
417 public static function getOptionGroupDataType($optionGroupName) {
418 $optionGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', $optionGroupName, 'id', 'name');
420 $dataType = CRM_Core_BAO_OptionGroup
::getDataType($optionGroupId);
425 * Process the form submission.
427 public function postProcess() {
428 if ($this->_action
& CRM_Core_Action
::DELETE
) {
429 $fieldValues = ['option_group_id' => $this->_gid
];
430 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $this->_id
, $fieldValues);
432 if (CRM_Core_BAO_OptionValue
::del($this->_id
)) {
433 if ($this->_gName
== 'phone_type') {
434 CRM_Core_BAO_Phone
::setOptionToNull(CRM_Utils_Array
::value('value', $this->_defaultValues
));
437 CRM_Core_Session
::setStatus(ts('Selected %1 type has been deleted.', [1 => $this->_gLabel
]), ts('Record Deleted'), 'success');
440 CRM_Core_Session
::setStatus(ts('Selected %1 type has not been deleted.', [1 => $this->_gLabel
]), ts('Sorry'), 'error');
441 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $fieldValues);
445 $params = $this->exportValues();
447 // allow multiple defaults within group.
448 $allowMultiDefaults = ['email_greeting', 'postal_greeting', 'addressee', 'from_email_address'];
449 if (in_array($this->_gName
, $allowMultiDefaults)) {
450 if ($this->_gName
== 'from_email_address') {
451 $params['reset_default_for'] = ['domain_id' => CRM_Core_Config
::domainID()];
453 elseif ($filter = CRM_Utils_Array
::value('contactOptions', $params)) {
454 $params['filter'] = $filter;
455 $params['reset_default_for'] = ['filter' => "0, " . $params['filter']];
458 //make sure we only have a single space, CRM-6977 and dev/mail/15
459 if ($this->_gName
== 'from_email_address') {
460 $params['label'] = $this->sanitizeFromEmailAddress($params['label']);
464 // set value of filter if not present in params
465 if ($this->_id
&& !array_key_exists('filter', $params)) {
466 if ($this->_gName
== 'participant_role') {
467 $params['filter'] = 0;
470 $params['filter'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'filter', 'id');
474 if (isset($params['color']) && strtolower($params['color']) == '#ffffff') {
475 $params['color'] = 'null';
478 $optionValue = CRM_Core_OptionValue
::addOptionValue($params, $this->_gName
, $this->_action
, $this->_id
);
480 CRM_Core_Session
::setStatus(ts('The %1 \'%2\' has been saved.', [
482 2 => $optionValue->label
,
483 ]), ts('Saved'), 'success');
485 $this->ajaxResponse
['optionValue'] = $optionValue->toArray();
489 public function sanitizeFromEmailAddress($email) {
490 preg_match("/^\"(.*)\" *<([^@>]*@[^@>]*)>$/", $email, $parts);
491 return "\"{$parts[1]}\" <$parts[2]>";