INFRA-132 - api/ - Misc
[civicrm-core.git] / CRM / Admin / Form / Options.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
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 */
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 /**
100fef9d 59 * Pre-process
6a488035 60 *
355ba699 61 * @return void
6a488035
TO
62 */
63 public function preProcess() {
64 parent::preProcess();
65 $session = CRM_Core_Session::singleton();
118e964e
CW
66 if (!$this->_gName && !empty($this->urlPath[3])) {
67 $this->_gName = $this->urlPath[3];
68 }
69 if (!$this->_gName && !empty($_GET['gid'])) {
70 $this->_gName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', (int) $_GET['gid'], 'name');
6a488035
TO
71 }
72 if ($this->_gName) {
73 $this->set('gName', $this->_gName);
74 }
75 else {
76 $this->_gName = $this->get('gName');
77 }
118e964e
CW
78 $this->_gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup',
79 $this->_gName,
80 'id',
81 'name'
82 );
faa2cea0 83 $this->_gLabel = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $this->_gid, 'title');
6a488035 84 $url = "civicrm/admin/options/{$this->_gName}";
faa2cea0 85 $params = "reset=1";
6a488035
TO
86
87 if (($this->_action & CRM_Core_Action::DELETE) &&
88 in_array($this->_gName, array('email_greeting', 'postal_greeting', 'addressee'))
89 ) {
90 // Don't allow delete if the option value belongs to addressee, postal or email greetings and is in use.
91 $findValue = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'value');
92 $queryParam = array(1 => array($findValue, 'Integer'));
93 $columnName = $this->_gName . "_id";
94 $sql = "SELECT count(id) FROM civicrm_contact WHERE " . $columnName . " = %1";
95 $isInUse = CRM_Core_DAO::singleValueQuery($sql, $queryParam);
96 if ($isInUse) {
97 $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 98 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
99 $redirect = CRM_Utils_System::url($url, $params);
100 CRM_Utils_System::redirect($redirect);
101 }
102 }
103
6a488035
TO
104 $session->pushUserContext(CRM_Utils_System::url($url, $params));
105 $this->assign('id', $this->_id);
106
107 if ($this->_id && in_array($this->_gName, CRM_Core_OptionGroup::$_domainIDGroups)) {
108 $domainID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'domain_id', 'id');
109 if (CRM_Core_Config::domainID() != $domainID) {
0499b0ad 110 CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
6a488035
TO
111 }
112 }
113 }
114
115 /**
c490a46a 116 * Set default values for the form.
6a488035
TO
117 * the default values are retrieved from the database
118 *
6a488035 119 *
355ba699 120 * @return void
6a488035 121 */
00be9182 122 public function setDefaultValues() {
6a488035
TO
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 /**
c490a46a 143 * Build the form object
6a488035 144 *
355ba699 145 * @return void
6a488035
TO
146 */
147 public function buildQuickForm() {
148 parent::buildQuickForm();
e2046b33
CW
149 $this->setPageTitle(ts('%1 Option', array(1 => $this->_gLabel)));
150
6a488035
TO
151 if ($this->_action & CRM_Core_Action::DELETE) {
152 return;
153 }
154
155 $this->applyFilter('__ALL__', 'trim');
156
157 $isReserved = FALSE;
158 if ($this->_id) {
159 $isReserved = (bool) CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'is_reserved');
160 }
161
162 $this->add('text',
163 'label',
164 ts('Label'),
165 CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'label'),
166 TRUE
167 );
168
169 if (!in_array($this->_gName, array(
170 'email_greeting', 'postal_greeting', 'addressee')) && !$isReserved) {
171 $this->addRule('label',
172 ts('This Label already exists in the database for this option group. Please select a different Value.'),
173 'optionExists',
174 array('CRM_Core_DAO_OptionValue', $this->_id, $this->_gid, 'label')
175 );
176 }
177
178 if ($this->_gName == 'case_status') {
02fc859b
TO
179 $classes = array(
180 'Opened' => ts('Opened'),
6a488035
TO
181 'Closed' => ts('Closed'),
182 );
183
184 $grouping = $this->add('select',
185 'grouping',
186 ts('Status Class'),
187 $classes
188 );
189 if ($isReserved) {
190 $grouping->freeze();
191 }
192 }
193 // CRM-11516
194 if ($this->_gName == 'payment_instrument') {
f743a6eb 195 $accountType = CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name = 'Asset' ");
6a488035 196 $financialAccount = CRM_Contribute_PseudoConstant::financialAccount(NULL, key($accountType));
8ef12e64 197
198 $this->add('select', 'financial_account_id', ts('Financial Account'),
fd1ae183
PN
199 array('' => ts('- select -')) + $financialAccount,
200 TRUE
6a488035
TO
201 );
202 }
203
204 $required = FALSE;
205 if ($this->_gName == 'custom_search') {
206 $required = TRUE;
207 }
208 elseif ($this->_gName == 'redaction_rule' || $this->_gName == 'engagement_index') {
209 $this->add('text',
210 'value',
211 ts('Value'),
212 CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'value'),
213 TRUE
214 );
215 if ($this->_gName == 'redaction_rule') {
216 $this->add('checkbox',
217 'filter',
218 ts('Regular Expression?')
219 );
220 }
221 }
222 if ($this->_gName == 'participant_listing') {
223 $this->add('text',
224 'description',
225 ts('Description'),
226 CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'description')
227 );
228 }
229 else {
230 // Hard-coding attributes here since description is still stored as varchar and not text in the schema. dgg
231 $this->addWysiwyg('description',
232 ts('Description'),
233 array('rows' => 4, 'cols' => 80),
234 $required
235 );
236 }
237
238 if ($this->_gName == 'event_badge') {
239 $this->add('text',
240 'name',
241 ts('Class Name'),
242 CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'name')
243 );
244 }
245
246 $this->add('text',
247 'weight',
7ecddde4 248 ts('Order'),
6a488035
TO
249 CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'weight'),
250 TRUE
251 );
252 $this->addRule('weight', ts('is a numeric field'), 'numeric');
253
254 // If CiviCase enabled AND "Add" mode OR "edit" mode for non-reserved activities, only allow user to pick Core or CiviCase component.
255 // FIXME: Each component should define whether adding new activity types is allowed.
256 $config = CRM_Core_Config::singleton();
257 if ($this->_gName == 'activity_type' && in_array("CiviCase", $config->enableComponents) &&
258 (($this->_action & CRM_Core_Action::ADD) || !$isReserved)
259 ) {
260 $caseID = CRM_Core_Component::getComponentID('CiviCase');
5ce691e5 261 $components = array('' => ts('Contacts AND Cases'), $caseID => ts('Cases Only'));
6a488035
TO
262 $this->add('select',
263 'component_id',
264 ts('Component'),
265 $components, FALSE
266 );
267 }
268
269 $enabled = $this->add('checkbox', 'is_active', ts('Enabled?'));
270
271 if ($isReserved) {
272 $enabled->freeze();
273 }
274
275 //fix for CRM-3552, CRM-4575
9eab4fdd 276 $showIsDefaultGroups = array(
277 'email_greeting',
278 'postal_greeting',
279 'addressee',
280 'from_email_address',
281 'case_status',
282 'encounter_medium',
283 'case_type',
284 'payment_instrument',
285 'communication_style',
694ca46e 286 'soft_credit_type',
3fff8d1e 287 'website_type',
9eab4fdd 288 );
289
290 if (in_array($this->_gName, $showIsDefaultGroups)) {
6a488035
TO
291 $this->assign('showDefault', TRUE);
292 $this->add('checkbox', 'is_default', ts('Default Option?'));
293 }
294
295 //get contact type for which user want to create a new greeting/addressee type, CRM-4575
296 if (in_array($this->_gName, array(
297 'email_greeting', 'postal_greeting', 'addressee')) && !$isReserved) {
02fc859b
TO
298 $values = array(
299 1 => ts('Individual'),
6a488035
TO
300 2 => ts('Household'),
301 3 => ts('Organization'),
302 4 => ts('Multiple Contact Merge'),
303 );
304 $this->add('select', 'contactOptions', ts('Contact Type'), array('' => '-select-') + $values, TRUE);
305 $this->assign('showContactFilter', TRUE);
306 }
307
308 if ($this->_gName == 'participant_status') {
309 // For Participant Status options, expose the 'filter' field to track which statuses are "Counted", and the Visibility field
310 $element = $this->add('checkbox', 'filter', ts('Counted?'));
311 $this->add('select', 'visibility_id', ts('Visibility'), CRM_Core_PseudoConstant::visibility());
312 }
313 if ($this->_gName == 'participant_role') {
314 // For Participant Role options, expose the 'filter' field to track which statuses are "Counted"
315 $this->add('checkbox', 'filter', ts('Counted?'));
316 }
317
318 $this->addFormRule(array('CRM_Admin_Form_Options', 'formRule'), $this);
319 }
320
321 /**
100fef9d 322 * Global form rule
6a488035 323 *
5173bd95
TO
324 * @param array $fields
325 * The input form values.
326 * @param array $files
327 * The uploaded files if any.
328 * @param array $self
329 * Current form object.
6a488035
TO
330 *
331 * @return array array of errors / empty array.
6a488035
TO
332 * @static
333 */
00be9182 334 public static function formRule($fields, $files, $self) {
6a488035 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)) {
f289559e 358 $errors['label'] = ts('Please enter a valid email address.');
6a488035
TO
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 /**
c490a46a 371 * Process the form submission
6a488035 372 *
6a488035 373 *
355ba699 374 * @return void
6a488035
TO
375 */
376 public function postProcess() {
377 if ($this->_action & CRM_Core_Action::DELETE) {
378 $fieldValues = array('option_group_id' => $this->_gid);
379 $wt = CRM_Utils_Weight::delWeight('CRM_Core_DAO_OptionValue', $this->_id, $fieldValues);
380
381 if (CRM_Core_BAO_OptionValue::del($this->_id)) {
382 if ($this->_gName == 'phone_type') {
383 CRM_Core_BAO_Phone::setOptionToNull(CRM_Utils_Array::value('value', $this->_defaultValues));
384 }
385
6c2473d5 386 CRM_Core_Session::setStatus(ts('Selected %1 type has been deleted.', array(1 => $this->_gLabel)), ts('Record Deleted'), 'success');
6a488035
TO
387 }
388 else {
6c2473d5 389 CRM_Core_Session::setStatus(ts('Selected %1 type has not been deleted.', array(1 => $this->_gLabel)), ts('Sorry'), 'error');
6a488035
TO
390 CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $fieldValues);
391 }
392 }
393 else {
394 $params = $ids = array();
395 $params = $this->exportValues();
396
397 // allow multiple defaults within group.
398 $allowMultiDefaults = array('email_greeting', 'postal_greeting', 'addressee', 'from_email_address');
399 if (in_array($this->_gName, $allowMultiDefaults)) {
400 if ($this->_gName == 'from_email_address') {
401 $params['reset_default_for'] = array('domain_id' => CRM_Core_Config::domainID());
402 }
403 elseif ($filter = CRM_Utils_Array::value('contactOptions', $params)) {
404 $params['filter'] = $filter;
405 $params['reset_default_for'] = array('filter' => "0, " . $params['filter']);
406 }
407
408 //make sure we should has to have space, CRM-6977
409 if ($this->_gName == 'from_email_address') {
410 $params['label'] = str_replace('"<', '" <', $params['label']);
411 }
412 }
413
74b187a2
KJ
414 // set value of filter if not present in params
415 if ($this->_id && !array_key_exists('filter', $params)) {
416 if ($this->_gName == 'participant_role') {
417 $params['filter'] = 0;
0db6c3e1
TO
418 }
419 else {
74b187a2
KJ
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}