3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
36 * This class generates form components generic to CiviCRM settings
38 class CRM_Admin_Form_Setting
extends CRM_Core_Form
{
41 protected $_settings = array();
44 * Set default values for the form.
46 * Default values are retrieved from the database.
48 public function setDefaultValues() {
49 if (!$this->_defaults
) {
50 $this->_defaults
= array();
51 $formArray = array('Component', 'Localization');
53 if (in_array($this->_name
, $formArray)) {
57 CRM_Core_BAO_ConfigSetting
::retrieve($this->_defaults
);
59 CRM_Core_Config_Defaults
::setValues($this->_defaults
, $formMode);
61 $list = array_flip(CRM_Core_OptionGroup
::values('contact_autocomplete_options',
62 FALSE, FALSE, TRUE, NULL, 'name'
65 $cRlist = array_flip(CRM_Core_OptionGroup
::values('contact_reference_options',
66 FALSE, FALSE, TRUE, NULL, 'name'
69 $listEnabled = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
70 'contact_autocomplete_options'
72 $cRlistEnabled = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
73 'contact_reference_options'
76 $autoSearchFields = array();
77 if (!empty($list) && !empty($listEnabled)) {
78 $autoSearchFields = array_combine($list, $listEnabled);
81 $cRSearchFields = array();
82 if (!empty($cRlist) && !empty($cRlistEnabled)) {
83 $cRSearchFields = array_combine($cRlist, $cRlistEnabled);
86 //Set defaults for autocomplete and contact reference options
87 $this->_defaults
['autocompleteContactSearch'] = array(
89 ) +
$autoSearchFields;
90 $this->_defaults
['autocompleteContactReference'] = array(
94 // we can handle all the ones defined in the metadata here. Others to be converted
95 foreach ($this->_settings
as $setting => $group) {
96 $settingMetaData = civicrm_api('setting', 'getfields', array('version' => 3, 'name' => $setting));
97 $this->_defaults
[$setting] = civicrm_api('setting', 'getvalue', array(
101 'default_value' => CRM_Utils_Array
::value('default', $settingMetaData['values'][$setting]),
106 $this->_defaults
['enableSSL'] = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'enableSSL', NULL, 0);
107 $this->_defaults
['verifySSL'] = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'verifySSL', NULL, 1);
110 return $this->_defaults
;
114 * Build the form object.
116 public function buildQuickForm() {
117 $session = CRM_Core_Session
::singleton();
118 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin', 'reset=1'));
119 $args = func_get_args();
120 $check = reset($args);
121 $this->addButtons(array(
124 'name' => ts('Save'),
129 'name' => ts('Cancel'),
134 foreach ($this->_settings
as $setting => $group) {
135 $settingMetaData = civicrm_api('setting', 'getfields', array('version' => 3, 'name' => $setting));
136 $props = $settingMetaData['values'][$setting];
137 if (isset($props['quick_form_type'])) {
138 $add = 'add' . $props['quick_form_type'];
139 if ($add == 'addElement') {
144 CRM_Utils_Array
::value($props['html_type'] == 'select' ?
'option_values' : 'html_attributes', $props, array()),
145 $props['html_type'] == 'select' ? CRM_Utils_Array
::value('html_attributes', $props) : NULL
149 $this->$add($setting, ts($props['title']));
151 $this->assign("{$setting}_description", ts($props['description']));
152 if ($setting == 'max_attachments') {
153 //temp hack @todo fix to get from metadata
154 $this->addRule('max_attachments', ts('Value should be a positive number'), 'positiveInteger');
156 if ($setting == 'maxFileSize') {
158 $this->addRule('maxFileSize', ts('Value should be a positive number'), 'positiveInteger');
166 * Process the form submission.
168 public function postProcess() {
169 // store the submitted values in an array
170 $params = $this->controller
->exportValues($this->_name
);
172 self
::commonProcess($params);
178 * @todo Document what I do.
180 * @param array $params
182 public function commonProcess(&$params) {
184 // save autocomplete search options
185 if (!empty($params['autocompleteContactSearch'])) {
186 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
187 array_keys($params['autocompleteContactSearch'])
188 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
190 CRM_Core_BAO_Setting
::setItem($value,
191 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
192 'contact_autocomplete_options'
195 unset($params['autocompleteContactSearch']);
198 // save autocomplete contact reference options
199 if (!empty($params['autocompleteContactReference'])) {
200 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
201 array_keys($params['autocompleteContactReference'])
202 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
204 CRM_Core_BAO_Setting
::setItem($value,
205 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
206 'contact_reference_options'
209 unset($params['autocompleteContactReference']);
212 // save components to be enabled
213 if (array_key_exists('enableComponents', $params)) {
214 CRM_Core_BAO_Setting
::setItem($params['enableComponents'],
215 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'enable_components');
217 // unset params by emptying the values, so while retrieving we can detect and load from settings table
218 // instead of config-backend for backward compatibility. We could use unset() in later releases.
219 $params['enableComponents'] = $params['enableComponentIDs'] = array();
222 // save checksum timeout
223 if (!empty($params['checksumTimeout'])) {
224 CRM_Core_BAO_Setting
::setItem($params['checksumTimeout'],
225 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
230 // update time for date formats when global time is changed
231 if (!empty($params['timeInputFormat'])) {
233 UPDATE civicrm_preferences_date
235 WHERE time_format IS NOT NULL
236 AND time_format <> ''
238 $sqlParams = array(1 => array($params['timeInputFormat'], 'String'));
239 CRM_Core_DAO
::executeQuery($query, $sqlParams);
242 // verify ssl peer option
243 if (isset($params['verifySSL'])) {
244 CRM_Core_BAO_Setting
::setItem($params['verifySSL'],
245 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
248 unset($params['verifySSL']);
252 if (isset($params['enableSSL'])) {
253 CRM_Core_BAO_Setting
::setItem($params['enableSSL'],
254 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
257 unset($params['enableSSL']);
259 $settings = array_intersect_key($params, $this->_settings
);
260 $result = civicrm_api('setting', 'create', $settings +
array('version' => 3));
261 foreach ($settings as $setting => $settingGroup) {
262 //@todo array_diff this
263 unset($params[$setting]);
265 CRM_Core_BAO_ConfigSetting
::create($params);
266 CRM_Core_Session
::setStatus(" ", ts('Changes Saved'), "success");
269 public function rebuildMenu() {
270 // ensure config is set with new values
271 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
273 // rebuild menu items
274 CRM_Core_Menu
::store();
276 // also delete the IDS file so we can write a new correct one on next load
277 $configFile = $config->uploadDir
. 'Config.IDS.ini';
278 @unlink
($configFile);