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
37 * This class generates form components generic to CiviCRM settings
40 class CRM_Admin_Form_Setting
extends CRM_Core_Form
{
43 protected $_settings = array();
46 * Set default values for the form.
47 * default values are retrieved from the database
52 public function setDefaultValues() {
53 if (!$this->_defaults
) {
54 $this->_defaults
= array();
55 $formArray = array('Component', 'Localization');
57 if (in_array($this->_name
, $formArray)) {
61 CRM_Core_BAO_ConfigSetting
::retrieve($this->_defaults
);
63 CRM_Core_Config_Defaults
::setValues($this->_defaults
, $formMode);
65 $list = array_flip(CRM_Core_OptionGroup
::values('contact_autocomplete_options',
66 FALSE, FALSE, TRUE, NULL, 'name'
69 $cRlist = array_flip(CRM_Core_OptionGroup
::values('contact_reference_options',
70 FALSE, FALSE, TRUE, NULL, 'name'
73 $listEnabled = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
74 'contact_autocomplete_options'
76 $cRlistEnabled = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
77 'contact_reference_options'
80 $autoSearchFields = array();
81 if (!empty($list) && !empty($listEnabled)) {
82 $autoSearchFields = array_combine($list, $listEnabled);
85 $cRSearchFields = array();
86 if (!empty($cRlist) && !empty($cRlistEnabled)) {
87 $cRSearchFields = array_combine($cRlist, $cRlistEnabled);
90 //Set defaults for autocomplete and contact reference options
91 $this->_defaults
['autocompleteContactSearch'] = array(
92 '1' => 1) +
$autoSearchFields;
93 $this->_defaults
['autocompleteContactReference'] = array(
94 '1' => 1) +
$cRSearchFields;
96 // we can handle all the ones defined in the metadata here. Others to be converted
97 foreach ($this->_settings
as $setting => $group){
98 $settingMetaData = civicrm_api('setting', 'getfields', array('version' => 3, 'name' => $setting));
99 $this->_defaults
[$setting] = civicrm_api('setting', 'getvalue', array(
103 'default_value' => CRM_Utils_Array
::value('default', $settingMetaData['values'][$setting])
108 $this->_defaults
['enableSSL'] = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'enableSSL', NULL, 0);
109 $this->_defaults
['verifySSL'] = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'verifySSL', NULL, 1);
112 return $this->_defaults
;
116 * Build the form object
120 public function buildQuickForm() {
121 $session = CRM_Core_Session
::singleton();
122 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin', 'reset=1'));
123 $args = func_get_args();
124 $check = reset($args);
125 $this->addButtons(array(
128 'name' => ts('Save'),
133 'name' => ts('Cancel'),
138 foreach ($this->_settings
as $setting => $group){
139 $settingMetaData = civicrm_api('setting', 'getfields', array('version' => 3, 'name' => $setting));
140 $props = $settingMetaData['values'][$setting];
141 if(isset($props['quick_form_type'])){
142 $add = 'add' . $props['quick_form_type'];
143 if($add == 'addElement'){
148 CRM_Utils_Array
::value($props['html_type'] == 'select' ?
'option_values' : 'html_attributes', $props, array()),
149 $props['html_type'] == 'select' ? CRM_Utils_Array
::value('html_attributes', $props) : NULL
153 $this->$add($setting, ts($props['title']));
155 $this->assign("{$setting}_description", ts($props['description']));
156 if($setting == 'max_attachments'){
157 //temp hack @todo fix to get from metadata
158 $this->addRule('max_attachments', ts('Value should be a positive number'), 'positiveInteger');
160 if($setting == 'maxFileSize'){
162 $this->addRule('maxFileSize', ts('Value should be a positive number'), 'positiveInteger');
170 * Process the form submission
175 public function postProcess() {
176 // store the submitted values in an array
177 $params = $this->controller
->exportValues($this->_name
);
179 self
::commonProcess($params);
183 * @param array $params
185 public function commonProcess(&$params) {
187 // save autocomplete search options
188 if (!empty($params['autocompleteContactSearch'])) {
189 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
190 array_keys($params['autocompleteContactSearch'])
191 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
193 CRM_Core_BAO_Setting
::setItem($value,
194 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
195 'contact_autocomplete_options'
198 unset($params['autocompleteContactSearch']);
201 // save autocomplete contact reference options
202 if (!empty($params['autocompleteContactReference'])) {
203 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
204 array_keys($params['autocompleteContactReference'])
205 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
207 CRM_Core_BAO_Setting
::setItem($value,
208 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
209 'contact_reference_options'
212 unset($params['autocompleteContactReference']);
215 // save components to be enabled
216 if (array_key_exists('enableComponents', $params)) {
217 CRM_Core_BAO_Setting
::setItem($params['enableComponents'],
218 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,'enable_components');
220 // unset params by emptying the values, so while retrieving we can detect and load from settings table
221 // instead of config-backend for backward compatibility. We could use unset() in later releases.
222 $params['enableComponents'] = $params['enableComponentIDs'] = array();
225 // save checksum timeout
226 if (!empty($params['checksumTimeout'])) {
227 CRM_Core_BAO_Setting
::setItem($params['checksumTimeout'],
228 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
233 // update time for date formats when global time is changed
234 if (!empty($params['timeInputFormat'])) {
236 UPDATE civicrm_preferences_date
238 WHERE time_format IS NOT NULL
239 AND time_format <> ''
241 $sqlParams = array(1 => array($params['timeInputFormat'], 'String'));
242 CRM_Core_DAO
::executeQuery($query, $sqlParams);
245 // verify ssl peer option
246 if (isset($params['verifySSL'])) {
247 CRM_Core_BAO_Setting
::setItem($params['verifySSL'],
248 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
251 unset($params['verifySSL']);
255 if (isset($params['enableSSL'])) {
256 CRM_Core_BAO_Setting
::setItem($params['enableSSL'],
257 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
260 unset($params['enableSSL']);
262 $settings = array_intersect_key($params, $this->_settings
);
263 $result = civicrm_api('setting', 'create', $settings +
array('version' => 3));
264 foreach ($settings as $setting => $settingGroup){
265 //@todo array_diff this
266 unset($params[$setting]);
268 CRM_Core_BAO_ConfigSetting
::create($params);
269 CRM_Core_Session
::setStatus(" ", ts('Changes Saved'), "success");
272 public function rebuildMenu() {
273 // ensure config is set with new values
274 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
276 // rebuild menu items
277 CRM_Core_Menu
::store();
279 // also delete the IDS file so we can write a new correct one on next load
280 $configFile = $config->uploadDir
. 'Config.IDS.ini';
281 @unlink
($configFile);