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