Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This class generates form components for Options | |
38 | * | |
39 | */ | |
40 | class 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(); | |
118e964e CW |
67 | if (!$this->_gName && !empty($this->urlPath[3])) { |
68 | $this->_gName = $this->urlPath[3]; | |
69 | } | |
70 | if (!$this->_gName && !empty($_GET['gid'])) { | |
71 | $this->_gName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', (int) $_GET['gid'], 'name'); | |
6a488035 TO |
72 | } |
73 | if ($this->_gName) { | |
74 | $this->set('gName', $this->_gName); | |
75 | } | |
76 | else { | |
77 | $this->_gName = $this->get('gName'); | |
78 | } | |
118e964e CW |
79 | $this->_gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', |
80 | $this->_gName, | |
81 | 'id', | |
82 | 'name' | |
83 | ); | |
faa2cea0 | 84 | $this->_gLabel = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $this->_gid, 'title'); |
6a488035 | 85 | $url = "civicrm/admin/options/{$this->_gName}"; |
faa2cea0 | 86 | $params = "reset=1"; |
6a488035 TO |
87 | |
88 | if (($this->_action & CRM_Core_Action::DELETE) && | |
89 | in_array($this->_gName, array('email_greeting', 'postal_greeting', 'addressee')) | |
90 | ) { | |
91 | // Don't allow delete if the option value belongs to addressee, postal or email greetings and is in use. | |
92 | $findValue = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'value'); | |
93 | $queryParam = array(1 => array($findValue, 'Integer')); | |
94 | $columnName = $this->_gName . "_id"; | |
95 | $sql = "SELECT count(id) FROM civicrm_contact WHERE " . $columnName . " = %1"; | |
96 | $isInUse = CRM_Core_DAO::singleValueQuery($sql, $queryParam); | |
97 | if ($isInUse) { | |
98 | $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 | 99 | 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 |
100 | $redirect = CRM_Utils_System::url($url, $params); |
101 | CRM_Utils_System::redirect($redirect); | |
102 | } | |
103 | } | |
104 | ||
105 | ||
106 | $session->pushUserContext(CRM_Utils_System::url($url, $params)); | |
107 | $this->assign('id', $this->_id); | |
108 | ||
109 | if ($this->_id && in_array($this->_gName, CRM_Core_OptionGroup::$_domainIDGroups)) { | |
110 | $domainID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'domain_id', 'id'); | |
111 | if (CRM_Core_Config::domainID() != $domainID) { | |
112 | CRM_Core_Error::fatal(ts('You do not have permission to access this page')); | |
113 | } | |
114 | } | |
115 | } | |
116 | ||
117 | /** | |
118 | * This function sets the default values for the form. | |
119 | * the default values are retrieved from the database | |
120 | * | |
121 | * @access public | |
122 | * | |
355ba699 | 123 | * @return void |
6a488035 TO |
124 | */ |
125 | function setDefaultValues() { | |
126 | $defaults = parent::setDefaultValues(); | |
127 | ||
128 | if (!isset($defaults['weight']) || !$defaults['weight']) { | |
129 | $fieldValues = array('option_group_id' => $this->_gid); | |
130 | $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', $fieldValues); | |
131 | } | |
132 | ||
133 | //setDefault of contact types for email greeting, postal greeting, addressee, CRM-4575 | |
134 | if (in_array($this->_gName, array( | |
135 | 'email_greeting', 'postal_greeting', 'addressee'))) { | |
136 | $defaults['contactOptions'] = (CRM_Utils_Array::value('filter', $defaults)) ? $defaults['filter'] : NULL; | |
137 | } | |
138 | // CRM-11516 | |
139 | if ($this->_gName == 'payment_instrument' && $this->_id) { | |
140 | $defaults['financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($this->_id, 'civicrm_option_value', 'financial_account_id'); | |
141 | } | |
142 | return $defaults; | |
143 | } | |
144 | ||
145 | /** | |
146 | * Function to build the form | |
147 | * | |
355ba699 | 148 | * @return void |
6a488035 TO |
149 | * @access public |
150 | */ | |
151 | public function buildQuickForm() { | |
152 | parent::buildQuickForm(); | |
e2046b33 CW |
153 | $this->setPageTitle(ts('%1 Option', array(1 => $this->_gLabel))); |
154 | ||
6a488035 TO |
155 | if ($this->_action & CRM_Core_Action::DELETE) { |
156 | return; | |
157 | } | |
158 | ||
159 | $this->applyFilter('__ALL__', 'trim'); | |
160 | ||
161 | $isReserved = FALSE; | |
162 | if ($this->_id) { | |
163 | $isReserved = (bool) CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'is_reserved'); | |
164 | } | |
165 | ||
166 | $this->add('text', | |
167 | 'label', | |
168 | ts('Label'), | |
169 | CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'label'), | |
170 | TRUE | |
171 | ); | |
172 | ||
173 | if (!in_array($this->_gName, array( | |
174 | 'email_greeting', 'postal_greeting', 'addressee')) && !$isReserved) { | |
175 | $this->addRule('label', | |
176 | ts('This Label already exists in the database for this option group. Please select a different Value.'), | |
177 | 'optionExists', | |
178 | array('CRM_Core_DAO_OptionValue', $this->_id, $this->_gid, 'label') | |
179 | ); | |
180 | } | |
181 | ||
182 | if ($this->_gName == 'case_status') { | |
183 | $classes = array('Opened' => ts('Opened'), | |
184 | 'Closed' => ts('Closed'), | |
185 | ); | |
186 | ||
187 | $grouping = $this->add('select', | |
188 | 'grouping', | |
189 | ts('Status Class'), | |
190 | $classes | |
191 | ); | |
192 | if ($isReserved) { | |
193 | $grouping->freeze(); | |
194 | } | |
195 | } | |
196 | // CRM-11516 | |
197 | if ($this->_gName == 'payment_instrument') { | |
f743a6eb | 198 | $accountType = CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name = 'Asset' "); |
6a488035 | 199 | $financialAccount = CRM_Contribute_PseudoConstant::financialAccount(NULL, key($accountType)); |
8ef12e64 | 200 | |
201 | $this->add('select', 'financial_account_id', ts('Financial Account'), | |
fd1ae183 PN |
202 | array('' => ts('- select -')) + $financialAccount, |
203 | TRUE | |
6a488035 TO |
204 | ); |
205 | } | |
206 | ||
207 | $required = FALSE; | |
208 | if ($this->_gName == 'custom_search') { | |
209 | $required = TRUE; | |
210 | } | |
211 | elseif ($this->_gName == 'redaction_rule' || $this->_gName == 'engagement_index') { | |
212 | $this->add('text', | |
213 | 'value', | |
214 | ts('Value'), | |
215 | CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'value'), | |
216 | TRUE | |
217 | ); | |
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 | |
234 | $this->addWysiwyg('description', | |
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', | |
251 | ts('Weight'), | |
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( | |
300 | 'email_greeting', 'postal_greeting', 'addressee')) && !$isReserved) { | |
301 | $values = array(1 => ts('Individual'), | |
302 | 2 => ts('Household'), | |
303 | 3 => ts('Organization'), | |
304 | 4 => ts('Multiple Contact Merge'), | |
305 | ); | |
306 | $this->add('select', 'contactOptions', ts('Contact Type'), array('' => '-select-') + $values, TRUE); | |
307 | $this->assign('showContactFilter', TRUE); | |
308 | } | |
309 | ||
310 | if ($this->_gName == 'participant_status') { | |
311 | // For Participant Status options, expose the 'filter' field to track which statuses are "Counted", and the Visibility field | |
312 | $element = $this->add('checkbox', 'filter', ts('Counted?')); | |
313 | $this->add('select', 'visibility_id', ts('Visibility'), CRM_Core_PseudoConstant::visibility()); | |
314 | } | |
315 | if ($this->_gName == 'participant_role') { | |
316 | // For Participant Role options, expose the 'filter' field to track which statuses are "Counted" | |
317 | $this->add('checkbox', 'filter', ts('Counted?')); | |
318 | } | |
319 | ||
320 | $this->addFormRule(array('CRM_Admin_Form_Options', 'formRule'), $this); | |
321 | } | |
322 | ||
323 | /** | |
324 | * global form rule | |
325 | * | |
326 | * @param array $fields the input form values | |
327 | * @param array $files the uploaded files if any | |
328 | * @param array $self current form object. | |
329 | * | |
330 | * @return array array of errors / empty array. | |
331 | * @access public | |
332 | * @static | |
333 | */ | |
334 | static function formRule($fields, $files, $self) { | |
335 | $errors = array(); | |
8cc574cf | 336 | if ($self->_gName == 'case_status' && empty($fields['grouping'])) { |
6a488035 TO |
337 | $errors['grouping'] = ts('Status class is a required field'); |
338 | } | |
339 | ||
8cc574cf | 340 | if (in_array($self->_gName, array('email_greeting', 'postal_greeting', 'addressee')) && empty($self->_defaultValues['is_reserved'])) { |
6a488035 TO |
341 | $label = $fields['label']; |
342 | $condition = " AND v.label = '{$label}' "; | |
343 | $values = CRM_Core_OptionGroup::values($self->_gName, FALSE, FALSE, FALSE, $condition, 'filter'); | |
344 | $checkContactOptions = TRUE; | |
345 | ||
346 | if ($self->_id && ($self->_defaultValues['contactOptions'] == $fields['contactOptions'])) { | |
347 | $checkContactOptions = FALSE; | |
348 | } | |
349 | ||
350 | if ($checkContactOptions && in_array($fields['contactOptions'], $values)) { | |
351 | $errors['label'] = ts('This Label already exists in the database for the selected contact type.'); | |
352 | } | |
353 | } | |
354 | ||
355 | if ($self->_gName == 'from_email_address') { | |
356 | $formEmail = CRM_Utils_Mail::pluckEmailFromHeader($fields['label']); | |
357 | if (!CRM_Utils_Rule::email($formEmail)) { | |
358 | $errors['label'] = ts('Please enter the valid email address.'); | |
359 | } | |
360 | ||
361 | $formName = explode('"', $fields['label']); | |
a7488080 | 362 | if (empty($formName[1]) || count($formName) != 3) { |
6a488035 TO |
363 | $errors['label'] = ts('Please follow the proper format for From Email Address'); |
364 | } | |
365 | } | |
366 | ||
367 | return $errors; | |
368 | } | |
369 | ||
370 | /** | |
371 | * Function to process the form | |
372 | * | |
373 | * @access public | |
374 | * | |
355ba699 | 375 | * @return void |
6a488035 TO |
376 | */ |
377 | public function postProcess() { | |
378 | if ($this->_action & CRM_Core_Action::DELETE) { | |
379 | $fieldValues = array('option_group_id' => $this->_gid); | |
380 | $wt = CRM_Utils_Weight::delWeight('CRM_Core_DAO_OptionValue', $this->_id, $fieldValues); | |
381 | ||
382 | if (CRM_Core_BAO_OptionValue::del($this->_id)) { | |
383 | if ($this->_gName == 'phone_type') { | |
384 | CRM_Core_BAO_Phone::setOptionToNull(CRM_Utils_Array::value('value', $this->_defaultValues)); | |
385 | } | |
386 | ||
6c2473d5 | 387 | CRM_Core_Session::setStatus(ts('Selected %1 type has been deleted.', array(1 => $this->_gLabel)), ts('Record Deleted'), 'success'); |
6a488035 TO |
388 | } |
389 | else { | |
6c2473d5 | 390 | CRM_Core_Session::setStatus(ts('Selected %1 type has not been deleted.', array(1 => $this->_gLabel)), ts('Sorry'), 'error'); |
6a488035 TO |
391 | CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $fieldValues); |
392 | } | |
393 | } | |
394 | else { | |
395 | $params = $ids = array(); | |
396 | $params = $this->exportValues(); | |
397 | ||
398 | // allow multiple defaults within group. | |
399 | $allowMultiDefaults = array('email_greeting', 'postal_greeting', 'addressee', 'from_email_address'); | |
400 | if (in_array($this->_gName, $allowMultiDefaults)) { | |
401 | if ($this->_gName == 'from_email_address') { | |
402 | $params['reset_default_for'] = array('domain_id' => CRM_Core_Config::domainID()); | |
403 | } | |
404 | elseif ($filter = CRM_Utils_Array::value('contactOptions', $params)) { | |
405 | $params['filter'] = $filter; | |
406 | $params['reset_default_for'] = array('filter' => "0, " . $params['filter']); | |
407 | } | |
408 | ||
409 | //make sure we should has to have space, CRM-6977 | |
410 | if ($this->_gName == 'from_email_address') { | |
411 | $params['label'] = str_replace('"<', '" <', $params['label']); | |
412 | } | |
413 | } | |
414 | ||
74b187a2 KJ |
415 | // set value of filter if not present in params |
416 | if ($this->_id && !array_key_exists('filter', $params)) { | |
417 | if ($this->_gName == 'participant_role') { | |
418 | $params['filter'] = 0; | |
419 | } else { | |
420 | $params['filter'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'filter', 'id'); | |
421 | } | |
6a488035 TO |
422 | } |
423 | ||
424 | $groupParams = array('name' => ($this->_gName)); | |
425 | $optionValue = CRM_Core_OptionValue::addOptionValue($params, $groupParams, $this->_action, $this->_id); | |
8ef12e64 | 426 | |
6a488035 | 427 | // CRM-11516 |
a7488080 | 428 | if (!empty($params['financial_account_id'])) { |
f743a6eb | 429 | $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' ")); |
6a488035 TO |
430 | $params = array( |
431 | 'entity_table' => 'civicrm_option_value', | |
432 | 'entity_id' => $optionValue->id, | |
433 | 'account_relationship' => $relationTypeId, | |
434 | 'financial_account_id' => $params['financial_account_id'] | |
435 | ); | |
436 | CRM_Financial_BAO_FinancialTypeAccount::add($params); | |
437 | } | |
438 | ||
6c2473d5 | 439 | CRM_Core_Session::setStatus(ts('The %1 \'%2\' has been saved.', array(1 => $this->_gLabel, 2 => $optionValue->label)), ts('Saved'), 'success'); |
6a488035 TO |
440 | } |
441 | } | |
e2046b33 | 442 | |
6a488035 | 443 | } |