3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 $this->addRule('label',
181 ts('This Label already exists in the database for this option group. Please select a different Value.'),
183 array('CRM_Core_DAO_OptionValue', $this->_id
, $this->_gid
, 'label')
187 if ($this->_gName
== 'case_status') {
189 'Opened' => ts('Opened'),
190 'Closed' => ts('Closed'),
193 $grouping = $this->add('select',
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));
207 $this->add('select', 'financial_account_id', ts('Financial Account'),
208 array('' => ts('- select -')) +
$financialAccount,
214 if ($this->_gName
== 'custom_search') {
217 elseif ($this->_gName
== 'redaction_rule' ||
$this->_gName
== 'engagement_index') {
218 if ($this->_gName
== 'redaction_rule') {
219 $this->add('checkbox',
221 ts('Regular Expression?')
225 if ($this->_gName
== 'participant_listing') {
229 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'description')
233 // Hard-coding attributes here since description is still stored as varchar and not text in the schema. dgg
234 $this->add('wysiwyg', 'description',
236 array('rows' => 4, 'cols' => 80),
241 if ($this->_gName
== 'event_badge') {
245 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'name')
252 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_OptionValue', 'weight'),
255 $this->addRule('weight', ts('is a numeric field'), 'numeric');
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)
263 $caseID = CRM_Core_Component
::getComponentID('CiviCase');
264 $components = array('' => ts('Contacts AND Cases'), $caseID => ts('Cases Only'));
272 $enabled = $this->add('checkbox', 'is_active', ts('Enabled?'));
278 //fix for CRM-3552, CRM-4575
279 $showIsDefaultGroups = array(
283 'from_email_address',
287 'payment_instrument',
288 'communication_style',
293 if (in_array($this->_gName
, $showIsDefaultGroups)) {
294 $this->assign('showDefault', TRUE);
295 $this->add('checkbox', 'is_default', ts('Default Option?'));
298 //get contact type for which user want to create a new greeting/addressee type, CRM-4575
299 if (in_array($this->_gName
, array(
306 1 => ts('Individual'),
307 2 => ts('Household'),
308 3 => ts('Organization'),
309 4 => ts('Multiple Contact Merge'),
311 $this->add('select', 'contactOptions', ts('Contact Type'), array('' => '-select-') +
$values, TRUE);
312 $this->assign('showContactFilter', TRUE);
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());
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?'));
325 $this->addFormRule(array('CRM_Admin_Form_Options', 'formRule'), $this);
331 * @param array $fields
332 * The input form values.
333 * @param array $files
334 * The uploaded files if any.
336 * Current form object.
339 * array of errors / empty array.
341 public static function formRule($fields, $files, $self) {
343 if ($self->_gName
== 'case_status' && empty($fields['grouping'])) {
344 $errors['grouping'] = ts('Status class is a required field');
347 if (in_array($self->_gName
, array(
351 )) && empty($self->_defaultValues
['is_reserved'])
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;
358 if ($self->_id
&& ($self->_defaultValues
['contactOptions'] == $fields['contactOptions'])) {
359 $checkContactOptions = FALSE;
362 if ($checkContactOptions && in_array($fields['contactOptions'], $values)) {
363 $errors['label'] = ts('This Label already exists in the database for the selected contact type.');
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.');
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');
383 * Process the form submission.
385 public function postProcess() {
386 if ($this->_action
& CRM_Core_Action
::DELETE
) {
387 $fieldValues = array('option_group_id' => $this->_gid
);
388 $wt = CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $this->_id
, $fieldValues);
390 if (CRM_Core_BAO_OptionValue
::del($this->_id
)) {
391 if ($this->_gName
== 'phone_type') {
392 CRM_Core_BAO_Phone
::setOptionToNull(CRM_Utils_Array
::value('value', $this->_defaultValues
));
395 CRM_Core_Session
::setStatus(ts('Selected %1 type has been deleted.', array(1 => $this->_gLabel
)), ts('Record Deleted'), 'success');
398 CRM_Core_Session
::setStatus(ts('Selected %1 type has not been deleted.', array(1 => $this->_gLabel
)), ts('Sorry'), 'error');
399 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $fieldValues);
403 $params = $ids = array();
404 $params = $this->exportValues();
406 // allow multiple defaults within group.
407 $allowMultiDefaults = array('email_greeting', 'postal_greeting', 'addressee', 'from_email_address');
408 if (in_array($this->_gName
, $allowMultiDefaults)) {
409 if ($this->_gName
== 'from_email_address') {
410 $params['reset_default_for'] = array('domain_id' => CRM_Core_Config
::domainID());
412 elseif ($filter = CRM_Utils_Array
::value('contactOptions', $params)) {
413 $params['filter'] = $filter;
414 $params['reset_default_for'] = array('filter' => "0, " . $params['filter']);
417 //make sure we should has to have space, CRM-6977
418 if ($this->_gName
== 'from_email_address') {
419 $params['label'] = str_replace('"<', '" <', $params['label']);
423 // set value of filter if not present in params
424 if ($this->_id
&& !array_key_exists('filter', $params)) {
425 if ($this->_gName
== 'participant_role') {
426 $params['filter'] = 0;
429 $params['filter'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id
, 'filter', 'id');
433 $groupParams = array('name' => ($this->_gName
));
434 $optionValue = CRM_Core_OptionValue
::addOptionValue($params, $groupParams, $this->_action
, $this->_id
);
437 if (!empty($params['financial_account_id'])) {
438 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
440 'entity_table' => 'civicrm_option_value',
441 'entity_id' => $optionValue->id
,
442 'account_relationship' => $relationTypeId,
443 'financial_account_id' => $params['financial_account_id'],
445 CRM_Financial_BAO_FinancialTypeAccount
::add($params);
448 CRM_Core_Session
::setStatus(ts('The %1 \'%2\' has been saved.', array(
450 2 => $optionValue->label
,
451 )), ts('Saved'), 'success');