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
19 * This class generates form components for Options.
21 class CRM_Admin_Form_Options
extends CRM_Admin_Form
{
24 * The option group name.
31 * The option group name in display format (capitalized, without underscores...etc)
38 * Is this Option Group Domain Specific
41 protected $_domainSpecific = FALSE;
46 public $submitOnce = TRUE;
51 public function preProcess() {
53 $session = CRM_Core_Session
::singleton();
54 if (!$this->_gName
&& !empty($this->urlPath
[3])) {
55 $this->_gName
= $this->urlPath
[3];
57 if (!$this->_gName
&& !empty($_GET['gid'])) {
58 $this->_gName
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', (int) $_GET['gid'], 'name');
61 $this->set('gName', $this->_gName
);
64 $this->_gName
= $this->get('gName');
66 $this->_gid
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
71 $this->_gLabel
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', $this->_gid
, 'title');
72 $this->_domainSpecific
= in_array($this->_gName
, CRM_Core_OptionGroup
::$_domainIDGroups);
73 $url = "civicrm/admin/options/{$this->_gName}";
76 if (($this->_action
& CRM_Core_Action
::DELETE
) &&
77 in_array($this->_gName
, ['email_greeting', 'postal_greeting', 'addressee'])
79 // Don't allow delete if the option value belongs to addressee, postal or email greetings and is in use.
80 $findValue = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'value');
81 $queryParam = [1 => [$findValue, 'Integer']];
82 $columnName = $this->_gName
. "_id";
83 $sql = "SELECT count(id) FROM civicrm_contact WHERE " . $columnName . " = %1";
84 $isInUse = CRM_Core_DAO
::singleValueQuery($sql, $queryParam);
86 $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>";
87 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', [
90 ]), ts('Sorry'), 'error');
91 $redirect = CRM_Utils_System
::url($url, $params);
92 CRM_Utils_System
::redirect($redirect);
96 $session->pushUserContext(CRM_Utils_System
::url($url, $params));
97 $this->assign('id', $this->_id
);
99 if ($this->_id
&& in_array($this->_gName
, CRM_Core_OptionGroup
::$_domainIDGroups)) {
100 $domainID = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'domain_id', 'id');
101 if (CRM_Core_Config
::domainID() != $domainID) {
102 CRM_Core_Error
::statusBounce(ts('You do not have permission to access this page.'));
108 * Set default values for the form.
110 public function setDefaultValues() {
111 $defaults = parent
::setDefaultValues();
113 // Default weight & value
114 $fieldValues = ['option_group_id' => $this->_gid
];
115 foreach (['weight', 'value'] as $field) {
116 if (empty($defaults[$field])) {
117 $defaults[$field] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $fieldValues, $field);
121 // setDefault of contact types for email greeting, postal greeting, addressee, CRM-4575
122 if (in_array($this->_gName
, [
127 $defaults['contactOptions'] = (CRM_Utils_Array
::value('filter', $defaults)) ?
$defaults['filter'] : NULL;
130 if ($this->_gName
== 'payment_instrument' && $this->_id
) {
131 $defaults['financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($this->_id
, NULL, 'civicrm_option_value');
133 if (empty($this->_id
) ||
!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'color')) {
134 $defaults['color'] = '#ffffff';
140 * Build the form object.
142 public function buildQuickForm() {
143 parent
::buildQuickForm();
144 $this->setPageTitle(ts('%1 Option', [1 => $this->_gLabel
]));
146 if ($this->_action
& CRM_Core_Action
::DELETE
) {
150 $this->applyFilter('__ALL__', 'trim');
154 $isReserved = (bool) CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'is_reserved');
160 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'label'),
164 if ($this->_gName
!= 'activity_type') {
168 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'value'),
171 $this->addRule('value',
172 ts('This Value already exists in the database for this option group. Please select a different Value.'),
174 ['CRM_Core_DAO_OptionValue', $this->_id
, $this->_gid
, 'value', $this->_domainSpecific
]
178 $this->add('text', 'icon', ts('Icon'), ['class' => 'crm-icon-picker', 'title' => ts('Choose Icon'), 'allowClear' => TRUE]);
181 if (in_array($this->_gName
, ['activity_status', 'case_status'])) {
182 $this->add('color', 'color', ts('Color'));
185 if (!in_array($this->_gName
, ['email_greeting', 'postal_greeting', 'addressee'])
188 $this->addRule('label',
189 ts('This Label already exists in the database for this option group. Please select a different Label.'),
191 ['CRM_Core_DAO_OptionValue', $this->_id
, $this->_gid
, 'label', $this->_domainSpecific
]
195 if ($this->_gName
== 'case_status') {
197 'Opened' => ts('Opened'),
198 'Closed' => ts('Closed'),
201 $grouping = $this->add('select',
211 if ($this->_gName
== 'payment_instrument') {
212 $accountType = CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name = 'Asset' ");
213 $financialAccount = CRM_Contribute_PseudoConstant
::financialAccount(NULL, key($accountType));
215 $this->add('select', 'financial_account_id', ts('Financial Account'),
216 ['' => ts('- select -')] +
$financialAccount,
221 if ($this->_gName
== 'activity_status') {
226 CRM_Activity_BAO_Activity
::INCOMPLETE
=> ts('Incomplete'),
227 CRM_Activity_BAO_Activity
::COMPLETED
=> ts('Completed'),
228 CRM_Activity_BAO_Activity
::CANCELLED
=> ts('Cancelled'),
232 if ($this->_gName
== 'redaction_rule') {
233 $this->add('checkbox',
235 ts('Regular Expression?')
238 if ($this->_gName
== 'participant_listing') {
242 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'description')
246 // Hard-coding attributes here since description is still stored as varchar and not text in the schema. dgg
247 $this->add('wysiwyg', 'description',
249 ['rows' => 4, 'cols' => 80],
250 $this->_gName
== 'custom_search'
254 if ($this->_gName
== 'event_badge') {
258 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'name')
265 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'weight'),
268 $this->addRule('weight', ts('is a numeric field'), 'numeric');
270 // If CiviCase enabled AND "Add" mode OR "edit" mode for non-reserved activities, only allow user to pick Core or CiviCase component.
271 // FIXME: Each component should define whether adding new activity types is allowed.
272 $config = CRM_Core_Config
::singleton();
273 if ($this->_gName
== 'activity_type' && in_array("CiviCase", $config->enableComponents
) &&
274 (($this->_action
& CRM_Core_Action
::ADD
) ||
!$isReserved)
276 $caseID = CRM_Core_Component
::getComponentID('CiviCase');
277 $components = ['' => ts('Contacts AND Cases'), $caseID => ts('Cases Only')];
285 $enabled = $this->add('checkbox', 'is_active', ts('Enabled?'));
291 // fix for CRM-3552, CRM-4575
292 $showIsDefaultGroups = [
296 'from_email_address',
300 'payment_instrument',
301 'communication_style',
306 if (in_array($this->_gName
, $showIsDefaultGroups)) {
307 $this->assign('showDefault', TRUE);
308 $this->add('checkbox', 'is_default', ts('Default Option?'));
311 // get contact type for which user want to create a new greeting/addressee type, CRM-4575
312 if (in_array($this->_gName
, ['email_greeting', 'postal_greeting', 'addressee'])
316 1 => ts('Individual'),
317 2 => ts('Household'),
318 3 => ts('Organization'),
319 4 => ts('Multiple Contact Merge'),
321 $this->add('select', 'contactOptions', ts('Contact Type'), ['' => '-select-'] +
$values, TRUE);
322 $this->assign('showContactFilter', TRUE);
325 if ($this->_gName
== 'participant_status') {
326 // For Participant Status options, expose the 'filter' field to track which statuses are "Counted", and the Visibility field
327 $this->add('checkbox', 'filter', ts('Counted?'));
328 $this->add('select', 'visibility_id', ts('Visibility'), CRM_Core_PseudoConstant
::visibility());
330 if ($this->_gName
== 'participant_role') {
331 // For Participant Role options, expose the 'filter' field to track which statuses are "Counted"
332 $this->add('checkbox', 'filter', ts('Counted?'));
335 $this->addFormRule(['CRM_Admin_Form_Options', 'formRule'], $this);
341 * @param array $fields
342 * The input form values.
343 * @param array $files
344 * The uploaded files if any.
346 * Current form object.
349 * array of errors / empty array.
350 * @throws \CRM_Core_Exception
352 public static function formRule($fields, $files, $self) {
354 if ($self->_gName
== 'case_status' && empty($fields['grouping'])) {
355 $errors['grouping'] = ts('Status class is a required field');
358 if (in_array($self->_gName
, ['email_greeting', 'postal_greeting', 'addressee'])
359 && empty($self->_defaultValues
['is_reserved'])
361 $label = $fields['label'];
362 $condition = " AND v.label = '{$label}' ";
363 $values = CRM_Core_OptionGroup
::values($self->_gName
, FALSE, FALSE, FALSE, $condition, 'filter');
364 $checkContactOptions = TRUE;
366 if ($self->_id
&& ($self->_defaultValues
['contactOptions'] == $fields['contactOptions'])) {
367 $checkContactOptions = FALSE;
370 if ($checkContactOptions && in_array($fields['contactOptions'], $values)) {
371 $errors['label'] = ts('This Label already exists in the database for the selected contact type.');
375 if ($self->_gName
== 'from_email_address') {
376 $formEmail = CRM_Utils_Mail
::pluckEmailFromHeader($fields['label']);
377 if (!CRM_Utils_Rule
::email($formEmail)) {
378 $errors['label'] = ts('Please enter a valid email address.');
381 $formName = explode('"', $fields['label']);
382 if (empty($formName[1]) ||
count($formName) != 3) {
383 $errors['label'] = ts('Please follow the proper format for From Email Address');
387 $dataType = self
::getOptionGroupDataType($self->_gName
);
388 if ($dataType && $self->_gName
!== 'activity_type') {
389 $validate = CRM_Utils_Type
::validate($fields['value'], $dataType, FALSE);
390 if ($validate === FALSE) {
391 CRM_Core_Session
::setStatus(
392 ts('Data Type of the value field for this option value does not match %1.', [1 => $dataType]),
393 ts('Value field Data Type mismatch'));
400 * Get the DataType for a specified Option Group.
402 * @param string $optionGroupName name of the option group
404 * @return string|null
406 public static function getOptionGroupDataType($optionGroupName) {
407 $optionGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', $optionGroupName, 'id', 'name');
409 $dataType = CRM_Core_BAO_OptionGroup
::getDataType($optionGroupId);
414 * Process the form submission.
416 public function postProcess() {
417 if ($this->_action
& CRM_Core_Action
::DELETE
) {
418 $fieldValues = ['option_group_id' => $this->_gid
];
419 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $this->_id
, $fieldValues);
421 if (CRM_Core_BAO_OptionValue
::del($this->_id
)) {
422 if ($this->_gName
== 'phone_type') {
423 CRM_Core_BAO_Phone
::setOptionToNull(CRM_Utils_Array
::value('value', $this->_defaultValues
));
426 CRM_Core_Session
::setStatus(ts('Selected %1 type has been deleted.', [1 => $this->_gLabel
]), ts('Record Deleted'), 'success');
429 CRM_Core_Session
::setStatus(ts('Selected %1 type has not been deleted.', [1 => $this->_gLabel
]), ts('Sorry'), 'error');
430 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $fieldValues);
434 $params = $this->exportValues();
436 // allow multiple defaults within group.
437 $allowMultiDefaults = ['email_greeting', 'postal_greeting', 'addressee', 'from_email_address'];
438 if (in_array($this->_gName
, $allowMultiDefaults)) {
439 if ($this->_gName
== 'from_email_address') {
440 $params['reset_default_for'] = ['domain_id' => CRM_Core_Config
::domainID()];
442 elseif ($filter = CRM_Utils_Array
::value('contactOptions', $params)) {
443 $params['filter'] = $filter;
444 $params['reset_default_for'] = ['filter' => "0, " . $params['filter']];
447 //make sure we only have a single space, CRM-6977 and dev/mail/15
448 if ($this->_gName
== 'from_email_address') {
449 $params['label'] = $this->sanitizeFromEmailAddress($params['label']);
453 // set value of filter if not present in params
454 if ($this->_id
&& !array_key_exists('filter', $params)) {
455 if ($this->_gName
== 'participant_role') {
456 $params['filter'] = 0;
459 $params['filter'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'filter', 'id');
463 if (isset($params['color']) && strtolower($params['color']) == '#ffffff') {
464 $params['color'] = 'null';
467 $optionValue = CRM_Core_OptionValue
::addOptionValue($params, $this->_gName
, $this->_action
, $this->_id
);
469 CRM_Core_Session
::setStatus(ts('The %1 \'%2\' has been saved.', [
471 2 => $optionValue->label
,
472 ]), ts('Saved'), 'success');
474 $this->ajaxResponse
['optionValue'] = $optionValue->toArray();
478 public function sanitizeFromEmailAddress($email) {
479 preg_match("/^\"(.*)\" *<([^@>]*@[^@>]*)>$/", $email, $parts);
480 return "\"{$parts[1]}\" <$parts[2]>";