3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
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 * This function sets the default values for the form.
47 * default values are retrieved from the database
53 function setDefaultValues() {
54 if (!$this->_defaults
) {
55 $this->_defaults
= array();
56 $formArray = array('Component', 'Localization');
58 if (in_array($this->_name
, $formArray)) {
62 CRM_Core_BAO_ConfigSetting
::retrieve($this->_defaults
);
64 CRM_Core_Config_Defaults
::setValues($this->_defaults
, $formMode);
66 $list = array_flip(CRM_Core_OptionGroup
::values('contact_autocomplete_options',
67 FALSE, FALSE, TRUE, NULL, 'name'
70 $cRlist = array_flip(CRM_Core_OptionGroup
::values('contact_reference_options',
71 FALSE, FALSE, TRUE, NULL, 'name'
74 $listEnabled = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
75 'contact_autocomplete_options'
77 $cRlistEnabled = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
78 'contact_reference_options'
81 $autoSearchFields = array();
82 if (!empty($list) && !empty($listEnabled)) {
83 $autoSearchFields = array_combine($list, $listEnabled);
86 $cRSearchFields = array();
87 if (!empty($cRlist) && !empty($cRlistEnabled)) {
88 $cRSearchFields = array_combine($cRlist, $cRlistEnabled);
91 //Set defaults for autocomplete and contact reference options
92 $this->_defaults
['autocompleteContactSearch'] = array(
93 '1' => 1) +
$autoSearchFields;
94 $this->_defaults
['autocompleteContactReference'] = array(
95 '1' => 1) +
$cRSearchFields;
97 // we can handle all the ones defined in the metadata here. Others to be converted
98 foreach ($this->_settings
as $setting => $group){
99 $settingMetaData = civicrm_api('setting', 'getfields', array('version' => 3, 'name' => $setting));
100 $this->_defaults
[$setting] = civicrm_api('setting', 'getvalue', array(
104 'default_value' => CRM_Utils_Array
::value('default', $settingMetaData['values'][$setting])
109 $this->_defaults
['enableSSL'] = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'enableSSL', NULL, 0);
110 $this->_defaults
['verifySSL'] = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'verifySSL', NULL, 1);
113 return $this->_defaults
;
117 * Function to actually build the form
122 public function buildQuickForm() {
123 $session = CRM_Core_Session
::singleton();
124 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin', 'reset=1'));
125 $args = func_get_args();
126 $check = reset($args);
127 $this->addButtons(array(
130 'name' => ts('Save'),
135 'name' => ts('Cancel'),
140 foreach ($this->_settings
as $setting => $group){
141 $settingMetaData = civicrm_api('setting', 'getfields', array('version' => 3, 'name' => $setting));
142 if(isset($settingMetaData['values'][$setting]['quick_form_type'])){
143 $add = 'add' . $settingMetaData['values'][$setting]['quick_form_type'];
144 if($add == 'addElement'){
146 $settingMetaData['values'][$setting]['html_type'],
148 ts($settingMetaData['values'][$setting]['title']),
149 CRM_Utils_Array
::value('html_attributes', $settingMetaData['values'][$setting], array())
153 $this->$add($setting, ts($settingMetaData['values'][$setting]['title']));
155 $this->assign("{$setting}_description", ts($settingMetaData['values'][$setting]['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 * Function to process the form
176 public function postProcess() {
177 // store the submitted values in an array
178 $params = $this->controller
->exportValues($this->_name
);
180 self
::commonProcess($params);
183 public function commonProcess(&$params) {
185 // save autocomplete search options
186 if (!empty($params['autocompleteContactSearch'])) {
187 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
188 array_keys($params['autocompleteContactSearch'])
189 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
191 CRM_Core_BAO_Setting
::setItem($value,
192 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
193 'contact_autocomplete_options'
196 unset($params['autocompleteContactSearch']);
199 // save autocomplete contact reference options
200 if (!empty($params['autocompleteContactReference'])) {
201 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
202 array_keys($params['autocompleteContactReference'])
203 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
205 CRM_Core_BAO_Setting
::setItem($value,
206 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
207 'contact_reference_options'
210 unset($params['autocompleteContactReference']);
213 // save components to be enabled
214 if (array_key_exists('enableComponents', $params)) {
215 CRM_Core_BAO_Setting
::setItem($params['enableComponents'],
216 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,'enable_components');
218 // unset params by emptying the values, so while retrieving we can detect and load from settings table
219 // instead of config-backend for backward compatibility. We could use unset() in later releases.
220 $params['enableComponents'] = $params['enableComponentIDs'] = array();
223 // save checksum timeout
224 if (!empty($params['checksumTimeout'])) {
225 CRM_Core_BAO_Setting
::setItem($params['checksumTimeout'],
226 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
231 // update time for date formats when global time is changed
232 if (!empty($params['timeInputFormat'])) {
234 UPDATE civicrm_preferences_date
236 WHERE time_format IS NOT NULL
237 AND time_format <> ''
239 $sqlParams = array(1 => array($params['timeInputFormat'], 'String'));
240 CRM_Core_DAO
::executeQuery($query, $sqlParams);
243 // verify ssl peer option
244 if (isset($params['verifySSL'])) {
245 CRM_Core_BAO_Setting
::setItem($params['verifySSL'],
246 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
249 unset($params['verifySSL']);
253 if (isset($params['enableSSL'])) {
254 CRM_Core_BAO_Setting
::setItem($params['enableSSL'],
255 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
258 unset($params['enableSSL']);
260 $settings = array_intersect_key($params, $this->_settings
);
261 $result = civicrm_api('setting', 'create', $settings +
array('version' => 3));
262 foreach ($settings as $setting => $settingGroup){
263 //@todo array_diff this
264 unset($params[$setting]);
266 CRM_Core_BAO_ConfigSetting
::create($params);
267 CRM_Core_Session
::setStatus(" ", ts('Changes Saved.'), "success");
270 public function rebuildMenu() {
271 // ensure config is set with new values
272 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
274 // rebuild menu items
275 CRM_Core_Menu
::store();
277 // also delete the IDS file so we can write a new correct one on next load
278 $configFile = $config->uploadDir
. 'Config.IDS.ini';
279 @unlink
($configFile);