Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
ce064e4f | 35 | * This class generates form components for Options. |
6a488035 TO |
36 | */ |
37 | class CRM_Admin_Form_Options extends CRM_Admin_Form { | |
38 | ||
39 | /** | |
eceb18cc | 40 | * The option group name. |
6a488035 TO |
41 | * |
42 | * @var array | |
6a488035 TO |
43 | */ |
44 | protected $_gName; | |
45 | ||
46 | /** | |
47 | * The option group name in display format (capitalized, without underscores...etc) | |
48 | * | |
49 | * @var array | |
6a488035 | 50 | */ |
6c2473d5 | 51 | protected $_gLabel; |
6a488035 TO |
52 | |
53 | /** | |
100fef9d | 54 | * Pre-process |
6a488035 TO |
55 | */ |
56 | public function preProcess() { | |
57 | parent::preProcess(); | |
58 | $session = CRM_Core_Session::singleton(); | |
118e964e CW |
59 | if (!$this->_gName && !empty($this->urlPath[3])) { |
60 | $this->_gName = $this->urlPath[3]; | |
61 | } | |
62 | if (!$this->_gName && !empty($_GET['gid'])) { | |
63 | $this->_gName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', (int) $_GET['gid'], 'name'); | |
6a488035 TO |
64 | } |
65 | if ($this->_gName) { | |
66 | $this->set('gName', $this->_gName); | |
67 | } | |
68 | else { | |
69 | $this->_gName = $this->get('gName'); | |
70 | } | |
118e964e CW |
71 | $this->_gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', |
72 | $this->_gName, | |
73 | 'id', | |
74 | 'name' | |
75 | ); | |
faa2cea0 | 76 | $this->_gLabel = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $this->_gid, 'title'); |
353ffa53 TO |
77 | $url = "civicrm/admin/options/{$this->_gName}"; |
78 | $params = "reset=1"; | |
6a488035 TO |
79 | |
80 | if (($this->_action & CRM_Core_Action::DELETE) && | |
81 | in_array($this->_gName, array('email_greeting', 'postal_greeting', 'addressee')) | |
82 | ) { | |
83 | // Don't allow delete if the option value belongs to addressee, postal or email greetings and is in use. | |
353ffa53 | 84 | $findValue = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'value'); |
6a488035 TO |
85 | $queryParam = array(1 => array($findValue, 'Integer')); |
86 | $columnName = $this->_gName . "_id"; | |
353ffa53 TO |
87 | $sql = "SELECT count(id) FROM civicrm_contact WHERE " . $columnName . " = %1"; |
88 | $isInUse = CRM_Core_DAO::singleValueQuery($sql, $queryParam); | |
6a488035 TO |
89 | if ($isInUse) { |
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>"; | |
353ffa53 TO |
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( |
92 | 1 => $this->_gLabel, | |
8d7a9d07 | 93 | 2 => $scriptURL, |
353ffa53 | 94 | )), ts('Sorry'), 'error'); |
6a488035 TO |
95 | $redirect = CRM_Utils_System::url($url, $params); |
96 | CRM_Utils_System::redirect($redirect); | |
97 | } | |
98 | } | |
99 | ||
6a488035 TO |
100 | $session->pushUserContext(CRM_Utils_System::url($url, $params)); |
101 | $this->assign('id', $this->_id); | |
102 | ||
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) { | |
0499b0ad | 106 | CRM_Core_Error::fatal(ts('You do not have permission to access this page.')); |
6a488035 TO |
107 | } |
108 | } | |
109 | } | |
110 | ||
111 | /** | |
c490a46a | 112 | * Set default values for the form. |
6a488035 | 113 | */ |
00be9182 | 114 | public function setDefaultValues() { |
6a488035 TO |
115 | $defaults = parent::setDefaultValues(); |
116 | ||
2b90b596 CW |
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); | |
122 | } | |
6a488035 TO |
123 | } |
124 | ||
125 | //setDefault of contact types for email greeting, postal greeting, addressee, CRM-4575 | |
126 | if (in_array($this->_gName, array( | |
353ffa53 TO |
127 | 'email_greeting', |
128 | 'postal_greeting', | |
8d7a9d07 | 129 | 'addressee', |
353ffa53 | 130 | ))) { |
6a488035 TO |
131 | $defaults['contactOptions'] = (CRM_Utils_Array::value('filter', $defaults)) ? $defaults['filter'] : NULL; |
132 | } | |
133 | // CRM-11516 | |
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'); | |
136 | } | |
137 | return $defaults; | |
138 | } | |
139 | ||
140 | /** | |
eceb18cc | 141 | * Build the form object. |
6a488035 TO |
142 | */ |
143 | public function buildQuickForm() { | |
144 | parent::buildQuickForm(); | |
e2046b33 CW |
145 | $this->setPageTitle(ts('%1 Option', array(1 => $this->_gLabel))); |
146 | ||
6a488035 TO |
147 | if ($this->_action & CRM_Core_Action::DELETE) { |
148 | return; | |
149 | } | |
150 | ||
151 | $this->applyFilter('__ALL__', 'trim'); | |
152 | ||
153 | $isReserved = FALSE; | |
154 | if ($this->_id) { | |
155 | $isReserved = (bool) CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'is_reserved'); | |
156 | } | |
157 | ||
158 | $this->add('text', | |
159 | 'label', | |
160 | ts('Label'), | |
161 | CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'label'), | |
162 | TRUE | |
163 | ); | |
164 | ||
635a99e5 CW |
165 | if ($this->_gName != 'activity_type') { |
166 | $this->add('text', | |
167 | 'value', | |
168 | ts('Value'), | |
169 | CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'value'), | |
170 | TRUE | |
171 | ); | |
172 | } | |
49c233c1 | 173 | |
6a488035 | 174 | if (!in_array($this->_gName, array( |
353ffa53 TO |
175 | 'email_greeting', |
176 | 'postal_greeting', | |
8d7a9d07 | 177 | 'addressee', |
353ffa53 TO |
178 | )) && !$isReserved |
179 | ) { | |
6a488035 TO |
180 | $this->addRule('label', |
181 | ts('This Label already exists in the database for this option group. Please select a different Value.'), | |
182 | 'optionExists', | |
183 | array('CRM_Core_DAO_OptionValue', $this->_id, $this->_gid, 'label') | |
184 | ); | |
185 | } | |
186 | ||
187 | if ($this->_gName == 'case_status') { | |
02fc859b | 188 | $classes = array( |
353ffa53 | 189 | 'Opened' => ts('Opened'), |
6a488035 TO |
190 | 'Closed' => ts('Closed'), |
191 | ); | |
192 | ||
193 | $grouping = $this->add('select', | |
194 | 'grouping', | |
195 | ts('Status Class'), | |
196 | $classes | |
197 | ); | |
198 | if ($isReserved) { | |
199 | $grouping->freeze(); | |
200 | } | |
201 | } | |
202 | // CRM-11516 | |
203 | if ($this->_gName == 'payment_instrument') { | |
f743a6eb | 204 | $accountType = CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name = 'Asset' "); |
6a488035 | 205 | $financialAccount = CRM_Contribute_PseudoConstant::financialAccount(NULL, key($accountType)); |
8ef12e64 | 206 | |
207 | $this->add('select', 'financial_account_id', ts('Financial Account'), | |
fd1ae183 PN |
208 | array('' => ts('- select -')) + $financialAccount, |
209 | TRUE | |
6a488035 TO |
210 | ); |
211 | } | |
212 | ||
213 | $required = FALSE; | |
214 | if ($this->_gName == 'custom_search') { | |
215 | $required = TRUE; | |
216 | } | |
217 | elseif ($this->_gName == 'redaction_rule' || $this->_gName == 'engagement_index') { | |
6a488035 TO |
218 | if ($this->_gName == 'redaction_rule') { |
219 | $this->add('checkbox', | |
220 | 'filter', | |
221 | ts('Regular Expression?') | |
222 | ); | |
223 | } | |
224 | } | |
225 | if ($this->_gName == 'participant_listing') { | |
226 | $this->add('text', | |
227 | 'description', | |
228 | ts('Description'), | |
229 | CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'description') | |
230 | ); | |
231 | } | |
232 | else { | |
233 | // Hard-coding attributes here since description is still stored as varchar and not text in the schema. dgg | |
5d51a2f9 | 234 | $this->add('wysiwyg', 'description', |
6a488035 TO |
235 | ts('Description'), |
236 | array('rows' => 4, 'cols' => 80), | |
237 | $required | |
238 | ); | |
239 | } | |
240 | ||
241 | if ($this->_gName == 'event_badge') { | |
242 | $this->add('text', | |
243 | 'name', | |
244 | ts('Class Name'), | |
245 | CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'name') | |
246 | ); | |
247 | } | |
248 | ||
249 | $this->add('text', | |
250 | 'weight', | |
7ecddde4 | 251 | ts('Order'), |
6a488035 TO |
252 | CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'weight'), |
253 | TRUE | |
254 | ); | |
255 | $this->addRule('weight', ts('is a numeric field'), 'numeric'); | |
256 | ||
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) | |
262 | ) { | |
263 | $caseID = CRM_Core_Component::getComponentID('CiviCase'); | |
5ce691e5 | 264 | $components = array('' => ts('Contacts AND Cases'), $caseID => ts('Cases Only')); |
6a488035 TO |
265 | $this->add('select', |
266 | 'component_id', | |
267 | ts('Component'), | |
268 | $components, FALSE | |
269 | ); | |
270 | } | |
271 | ||
272 | $enabled = $this->add('checkbox', 'is_active', ts('Enabled?')); | |
273 | ||
274 | if ($isReserved) { | |
275 | $enabled->freeze(); | |
276 | } | |
277 | ||
278 | //fix for CRM-3552, CRM-4575 | |
9eab4fdd | 279 | $showIsDefaultGroups = array( |
280 | 'email_greeting', | |
281 | 'postal_greeting', | |
282 | 'addressee', | |
283 | 'from_email_address', | |
284 | 'case_status', | |
285 | 'encounter_medium', | |
286 | 'case_type', | |
287 | 'payment_instrument', | |
288 | 'communication_style', | |
694ca46e | 289 | 'soft_credit_type', |
3fff8d1e | 290 | 'website_type', |
9eab4fdd | 291 | ); |
292 | ||
293 | if (in_array($this->_gName, $showIsDefaultGroups)) { | |
6a488035 TO |
294 | $this->assign('showDefault', TRUE); |
295 | $this->add('checkbox', 'is_default', ts('Default Option?')); | |
296 | } | |
297 | ||
298 | //get contact type for which user want to create a new greeting/addressee type, CRM-4575 | |
299 | if (in_array($this->_gName, array( | |
353ffa53 TO |
300 | 'email_greeting', |
301 | 'postal_greeting', | |
8d7a9d07 | 302 | 'addressee', |
353ffa53 TO |
303 | )) && !$isReserved |
304 | ) { | |
02fc859b | 305 | $values = array( |
353ffa53 | 306 | 1 => ts('Individual'), |
6a488035 TO |
307 | 2 => ts('Household'), |
308 | 3 => ts('Organization'), | |
309 | 4 => ts('Multiple Contact Merge'), | |
310 | ); | |
311 | $this->add('select', 'contactOptions', ts('Contact Type'), array('' => '-select-') + $values, TRUE); | |
312 | $this->assign('showContactFilter', TRUE); | |
313 | } | |
314 | ||
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()); | |
319 | } | |
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?')); | |
323 | } | |
324 | ||
325 | $this->addFormRule(array('CRM_Admin_Form_Options', 'formRule'), $this); | |
326 | } | |
327 | ||
328 | /** | |
eceb18cc | 329 | * Global form rule. |
6a488035 | 330 | * |
5173bd95 TO |
331 | * @param array $fields |
332 | * The input form values. | |
333 | * @param array $files | |
334 | * The uploaded files if any. | |
335 | * @param array $self | |
336 | * Current form object. | |
6a488035 | 337 | * |
a6c01b45 CW |
338 | * @return array |
339 | * array of errors / empty array. | |
6a488035 | 340 | */ |
00be9182 | 341 | public static function formRule($fields, $files, $self) { |
6a488035 | 342 | $errors = array(); |
8cc574cf | 343 | if ($self->_gName == 'case_status' && empty($fields['grouping'])) { |
6a488035 TO |
344 | $errors['grouping'] = ts('Status class is a required field'); |
345 | } | |
346 | ||
353ffa53 TO |
347 | if (in_array($self->_gName, array( |
348 | 'email_greeting', | |
349 | 'postal_greeting', | |
8d7a9d07 | 350 | 'addressee', |
353ffa53 TO |
351 | )) && empty($self->_defaultValues['is_reserved']) |
352 | ) { | |
353 | $label = $fields['label']; | |
354 | $condition = " AND v.label = '{$label}' "; | |
355 | $values = CRM_Core_OptionGroup::values($self->_gName, FALSE, FALSE, FALSE, $condition, 'filter'); | |
6a488035 TO |
356 | $checkContactOptions = TRUE; |
357 | ||
358 | if ($self->_id && ($self->_defaultValues['contactOptions'] == $fields['contactOptions'])) { | |
359 | $checkContactOptions = FALSE; | |
360 | } | |
361 | ||
362 | if ($checkContactOptions && in_array($fields['contactOptions'], $values)) { | |
363 | $errors['label'] = ts('This Label already exists in the database for the selected contact type.'); | |
364 | } | |
365 | } | |
366 | ||
367 | if ($self->_gName == 'from_email_address') { | |
368 | $formEmail = CRM_Utils_Mail::pluckEmailFromHeader($fields['label']); | |
369 | if (!CRM_Utils_Rule::email($formEmail)) { | |
f289559e | 370 | $errors['label'] = ts('Please enter a valid email address.'); |
6a488035 TO |
371 | } |
372 | ||
373 | $formName = explode('"', $fields['label']); | |
a7488080 | 374 | if (empty($formName[1]) || count($formName) != 3) { |
6a488035 TO |
375 | $errors['label'] = ts('Please follow the proper format for From Email Address'); |
376 | } | |
377 | } | |
378 | ||
379 | return $errors; | |
380 | } | |
381 | ||
382 | /** | |
eceb18cc | 383 | * Process the form submission. |
6a488035 TO |
384 | */ |
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); | |
389 | ||
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)); | |
393 | } | |
394 | ||
6c2473d5 | 395 | CRM_Core_Session::setStatus(ts('Selected %1 type has been deleted.', array(1 => $this->_gLabel)), ts('Record Deleted'), 'success'); |
6a488035 TO |
396 | } |
397 | else { | |
6c2473d5 | 398 | CRM_Core_Session::setStatus(ts('Selected %1 type has not been deleted.', array(1 => $this->_gLabel)), ts('Sorry'), 'error'); |
6a488035 TO |
399 | CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $fieldValues); |
400 | } | |
401 | } | |
402 | else { | |
403 | $params = $ids = array(); | |
404 | $params = $this->exportValues(); | |
405 | ||
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()); | |
411 | } | |
412 | elseif ($filter = CRM_Utils_Array::value('contactOptions', $params)) { | |
413 | $params['filter'] = $filter; | |
414 | $params['reset_default_for'] = array('filter' => "0, " . $params['filter']); | |
415 | } | |
416 | ||
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']); | |
420 | } | |
421 | } | |
422 | ||
74b187a2 KJ |
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; | |
0db6c3e1 TO |
427 | } |
428 | else { | |
74b187a2 KJ |
429 | $params['filter'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'filter', 'id'); |
430 | } | |
6a488035 TO |
431 | } |
432 | ||
433 | $groupParams = array('name' => ($this->_gName)); | |
434 | $optionValue = CRM_Core_OptionValue::addOptionValue($params, $groupParams, $this->_action, $this->_id); | |
8ef12e64 | 435 | |
6a488035 | 436 | // CRM-11516 |
a7488080 | 437 | if (!empty($params['financial_account_id'])) { |
f743a6eb | 438 | $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' ")); |
6a488035 TO |
439 | $params = array( |
440 | 'entity_table' => 'civicrm_option_value', | |
441 | 'entity_id' => $optionValue->id, | |
442 | 'account_relationship' => $relationTypeId, | |
21dfd5f5 | 443 | 'financial_account_id' => $params['financial_account_id'], |
6a488035 TO |
444 | ); |
445 | CRM_Financial_BAO_FinancialTypeAccount::add($params); | |
446 | } | |
447 | ||
353ffa53 TO |
448 | CRM_Core_Session::setStatus(ts('The %1 \'%2\' has been saved.', array( |
449 | 1 => $this->_gLabel, | |
8d7a9d07 | 450 | 2 => $optionValue->label, |
353ffa53 | 451 | )), ts('Saved'), 'success'); |
6a488035 TO |
452 | } |
453 | } | |
e2046b33 | 454 | |
6a488035 | 455 | } |