3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
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)
56 public function preProcess() {
58 $session = CRM_Core_Session
::singleton();
59 if (!$this->_gName
&& !empty($this->urlPath
[3])) {
60 $this->_gName
= $this->urlPath
[3];
62 if (!$this->_gName
&& !empty($_GET['gid'])) {
63 $this->_gName
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', (int) $_GET['gid'], 'name');
66 $this->set('gName', $this->_gName
);
69 $this->_gName
= $this->get('gName');
71 $this->_gid
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
76 $this->_gLabel
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', $this->_gid
, 'title');
77 $url = "civicrm/admin/options/{$this->_gName}";
80 if (($this->_action
& CRM_Core_Action
::DELETE
) &&
81 in_array($this->_gName
, array('email_greeting', 'postal_greeting', 'addressee'))
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);
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(
94 )), ts('Sorry'), 'error');
95 $redirect = CRM_Utils_System
::url($url, $params);
96 CRM_Utils_System
::redirect($redirect);
100 $session->pushUserContext(CRM_Utils_System
::url($url, $params));
101 $this->assign('id', $this->_id
);
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.'));
112 * Set default values for the form.
114 public function setDefaultValues() {
115 $defaults = parent
::setDefaultValues();
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);
125 //setDefault of contact types for email greeting, postal greeting, addressee, CRM-4575
126 if (in_array($this->_gName
, array(
131 $defaults['contactOptions'] = (CRM_Utils_Array
::value('filter', $defaults)) ?
$defaults['filter'] : NULL;
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');
141 * Build the form object.
143 public function buildQuickForm() {
144 parent
::buildQuickForm();
145 $this->setPageTitle(ts('%1 Option', array(1 => $this->_gLabel
)));
147 if ($this->_action
& CRM_Core_Action
::DELETE
) {
151 $this->applyFilter('__ALL__', 'trim');
155 $isReserved = (bool) CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'is_reserved');
161 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'label'),
165 if ($this->_gName
!= 'activity_type') {
169 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'value'),
174 if (!in_array($this->_gName
, array(
180 $domainSpecificOptionGroups = array('from_email_address');
181 $domainSpecific = in_array($this->_gName
, $domainSpecificOptionGroups) ?
TRUE : FALSE;
182 $this->addRule('label',
183 ts('This Label already exists in the database for this option group. Please select a different Value.'),
185 array('CRM_Core_DAO_OptionValue', $this->_id
, $this->_gid
, 'label', $domainSpecific)
189 if ($this->_gName
== 'case_status') {
191 'Opened' => ts('Opened'),
192 'Closed' => ts('Closed'),
195 $grouping = $this->add('select',
205 if ($this->_gName
== 'payment_instrument') {
206 $accountType = CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name = 'Asset' ");
207 $financialAccount = CRM_Contribute_PseudoConstant
::financialAccount(NULL, key($accountType));
209 $this->add('select', 'financial_account_id', ts('Financial Account'),
210 array('' => ts('- select -')) +
$financialAccount,
216 if ($this->_gName
== 'custom_search') {
219 elseif ($this->_gName
== 'redaction_rule' ||
$this->_gName
== 'engagement_index') {
220 if ($this->_gName
== 'redaction_rule') {
221 $this->add('checkbox',
223 ts('Regular Expression?')
227 if ($this->_gName
== 'participant_listing') {
231 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'description')
235 // Hard-coding attributes here since description is still stored as varchar and not text in the schema. dgg
236 $this->add('wysiwyg', 'description',
238 array('rows' => 4, 'cols' => 80),
243 if ($this->_gName
== 'event_badge') {
247 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'name')
254 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'weight'),
257 $this->addRule('weight', ts('is a numeric field'), 'numeric');
259 // If CiviCase enabled AND "Add" mode OR "edit" mode for non-reserved activities, only allow user to pick Core or CiviCase component.
260 // FIXME: Each component should define whether adding new activity types is allowed.
261 $config = CRM_Core_Config
::singleton();
262 if ($this->_gName
== 'activity_type' && in_array("CiviCase", $config->enableComponents
) &&
263 (($this->_action
& CRM_Core_Action
::ADD
) ||
!$isReserved)
265 $caseID = CRM_Core_Component
::getComponentID('CiviCase');
266 $components = array('' => ts('Contacts AND Cases'), $caseID => ts('Cases Only'));
274 $enabled = $this->add('checkbox', 'is_active', ts('Enabled?'));
280 //fix for CRM-3552, CRM-4575
281 $showIsDefaultGroups = array(
285 'from_email_address',
289 'payment_instrument',
290 'communication_style',
295 if (in_array($this->_gName
, $showIsDefaultGroups)) {
296 $this->assign('showDefault', TRUE);
297 $this->add('checkbox', 'is_default', ts('Default Option?'));
300 //get contact type for which user want to create a new greeting/addressee type, CRM-4575
301 if (in_array($this->_gName
, array(
308 1 => ts('Individual'),
309 2 => ts('Household'),
310 3 => ts('Organization'),
311 4 => ts('Multiple Contact Merge'),
313 $this->add('select', 'contactOptions', ts('Contact Type'), array('' => '-select-') +
$values, TRUE);
314 $this->assign('showContactFilter', TRUE);
317 if ($this->_gName
== 'participant_status') {
318 // For Participant Status options, expose the 'filter' field to track which statuses are "Counted", and the Visibility field
319 $element = $this->add('checkbox', 'filter', ts('Counted?'));
320 $this->add('select', 'visibility_id', ts('Visibility'), CRM_Core_PseudoConstant
::visibility());
322 if ($this->_gName
== 'participant_role') {
323 // For Participant Role options, expose the 'filter' field to track which statuses are "Counted"
324 $this->add('checkbox', 'filter', ts('Counted?'));
327 $this->addFormRule(array('CRM_Admin_Form_Options', 'formRule'), $this);
333 * @param array $fields
334 * The input form values.
335 * @param array $files
336 * The uploaded files if any.
338 * Current form object.
341 * array of errors / empty array.
343 public static function formRule($fields, $files, $self) {
345 if ($self->_gName
== 'case_status' && empty($fields['grouping'])) {
346 $errors['grouping'] = ts('Status class is a required field');
349 if (in_array($self->_gName
, array(
353 )) && empty($self->_defaultValues
['is_reserved'])
355 $label = $fields['label'];
356 $condition = " AND v.label = '{$label}' ";
357 $values = CRM_Core_OptionGroup
::values($self->_gName
, FALSE, FALSE, FALSE, $condition, 'filter');
358 $checkContactOptions = TRUE;
360 if ($self->_id
&& ($self->_defaultValues
['contactOptions'] == $fields['contactOptions'])) {
361 $checkContactOptions = FALSE;
364 if ($checkContactOptions && in_array($fields['contactOptions'], $values)) {
365 $errors['label'] = ts('This Label already exists in the database for the selected contact type.');
369 if ($self->_gName
== 'from_email_address') {
370 $formEmail = CRM_Utils_Mail
::pluckEmailFromHeader($fields['label']);
371 if (!CRM_Utils_Rule
::email($formEmail)) {
372 $errors['label'] = ts('Please enter a valid email address.');
375 $formName = explode('"', $fields['label']);
376 if (empty($formName[1]) ||
count($formName) != 3) {
377 $errors['label'] = ts('Please follow the proper format for From Email Address');
381 $dataType = self
::getOptionGroupDataType($self->_gName
);
382 if ($dataType && $self->_gName
!== 'activity_type') {
383 $validate = CRM_Utils_Type
::validate($fields['value'], $dataType, FALSE);
385 CRM_Core_Session
::setStatus(
386 ts('Data Type of the value field for this option value does not match ' . $dataType),
387 ts('Value field Data Type mismatch'));
394 * Get the DataType for a specified Option Group.
396 * @param string $optionGroupName name of the option group
398 * @return string|null
400 public static function getOptionGroupDataType($optionGroupName) {
401 $optionGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', $optionGroupName, 'id', 'name');
403 $dataType = CRM_Core_BAO_OptionGroup
::getDataType($optionGroupId);
408 * Process the form submission.
410 public function postProcess() {
411 if ($this->_action
& CRM_Core_Action
::DELETE
) {
412 $fieldValues = array('option_group_id' => $this->_gid
);
413 $wt = CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $this->_id
, $fieldValues);
415 if (CRM_Core_BAO_OptionValue
::del($this->_id
)) {
416 if ($this->_gName
== 'phone_type') {
417 CRM_Core_BAO_Phone
::setOptionToNull(CRM_Utils_Array
::value('value', $this->_defaultValues
));
420 CRM_Core_Session
::setStatus(ts('Selected %1 type has been deleted.', array(1 => $this->_gLabel
)), ts('Record Deleted'), 'success');
423 CRM_Core_Session
::setStatus(ts('Selected %1 type has not been deleted.', array(1 => $this->_gLabel
)), ts('Sorry'), 'error');
424 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $fieldValues);
428 $params = $ids = array();
429 $params = $this->exportValues();
431 // allow multiple defaults within group.
432 $allowMultiDefaults = array('email_greeting', 'postal_greeting', 'addressee', 'from_email_address');
433 if (in_array($this->_gName
, $allowMultiDefaults)) {
434 if ($this->_gName
== 'from_email_address') {
435 $params['reset_default_for'] = array('domain_id' => CRM_Core_Config
::domainID());
437 elseif ($filter = CRM_Utils_Array
::value('contactOptions', $params)) {
438 $params['filter'] = $filter;
439 $params['reset_default_for'] = array('filter' => "0, " . $params['filter']);
442 //make sure we should has to have space, CRM-6977
443 if ($this->_gName
== 'from_email_address') {
444 $params['label'] = str_replace('"<', '" <', $params['label']);
448 // set value of filter if not present in params
449 if ($this->_id
&& !array_key_exists('filter', $params)) {
450 if ($this->_gName
== 'participant_role') {
451 $params['filter'] = 0;
454 $params['filter'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'filter', 'id');
458 $groupParams = array('name' => ($this->_gName
));
459 $optionValue = CRM_Core_OptionValue
::addOptionValue($params, $groupParams, $this->_action
, $this->_id
);
462 if (!empty($params['financial_account_id'])) {
463 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
465 'entity_table' => 'civicrm_option_value',
466 'entity_id' => $optionValue->id
,
467 'account_relationship' => $relationTypeId,
468 'financial_account_id' => $params['financial_account_id'],
470 CRM_Financial_BAO_FinancialTypeAccount
::add($params);
473 CRM_Core_Session
::setStatus(ts('The %1 \'%2\' has been saved.', array(
475 2 => $optionValue->label
,
476 )), ts('Saved'), 'success');