Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | ||
18 | /** | |
7f3c8b3d | 19 | * This class is for UF Group (Profile) configuration. |
6a488035 TO |
20 | */ |
21 | class CRM_UF_Form_Group extends CRM_Core_Form { | |
22 | ||
7f3c8b3d | 23 | use CRM_Core_Form_EntityFormTrait; |
24 | ||
25 | /** | |
26 | * Fields for the entity to be assigned to the template. | |
27 | * | |
28 | * Fields may have keys | |
29 | * - name (required to show in tpl from the array) | |
30 | * - description (optional, will appear below the field) | |
31 | * - not-auto-addable - this class will not attempt to add the field using addField. | |
32 | * (this will be automatically set if the field does not have html in it's metadata | |
33 | * or is not a core field on the form's entity). | |
34 | * - help (option) add help to the field - e.g ['id' => 'id-source', 'file' => 'CRM/Contact/Form/Contact']] | |
35 | * - template - use a field specific template to render this field | |
36 | * - required | |
37 | * - is_freeze (field should be frozen). | |
38 | * | |
39 | * @var array | |
40 | */ | |
41 | protected $entityFields = []; | |
42 | ||
154975ba PN |
43 | /** |
44 | * Deletion message to be assigned to the form. | |
45 | * | |
46 | * @var string | |
47 | */ | |
48 | protected $deleteMessage; | |
49 | ||
7f3c8b3d | 50 | /** |
51 | * Set entity fields to be assigned to the form. | |
52 | */ | |
53 | protected function setEntityFields() { | |
54 | $this->entityFields = [ | |
55 | 'title' => ['name' => 'title'], | |
56 | 'frontend_title' => ['name' => 'frontend_title'], | |
927f5956 | 57 | 'description' => [ |
58 | 'name' => 'description', | |
59 | 'help' => ['id' => 'id-description', 'file' => 'CRM/UF/Form/Group.hlp'], | |
60 | ], | |
61 | 'uf_group_type' => [ | |
62 | 'name' => 'uf_group_type', | |
63 | 'not-auto-addable' => TRUE, | |
64 | 'help' => ['id' => 'id-used_for', 'file' => 'CRM/UF/Form/Group.hlp'], | |
65 | 'post_html_text' => ' ' . $this->getOtherModuleString(), | |
66 | ], | |
67 | 'cancel_button_text' => [ | |
68 | 'name' => 'cancel_button_text', | |
69 | 'help' => [ | |
70 | 'id' => 'id-cancel_button_text', | |
71 | 'file' => 'CRM/UF/Form/Group.hlp', | |
72 | ], | |
73 | 'class' => 'cancel_button_section', | |
74 | ], | |
75 | 'submit_button_text' => [ | |
76 | 'name' => 'submit_button_text', | |
77 | 'help' => [ | |
78 | 'id' => 'id-submit_button_text', | |
79 | 'file' => 'CRM/UF/Form/Group.hlp', | |
80 | ], | |
81 | 'class' => '', | |
82 | ], | |
7f3c8b3d | 83 | ]; |
84 | } | |
85 | ||
86 | /** | |
87 | * Explicitly declare the entity api name. | |
88 | */ | |
89 | public function getDefaultEntity() { | |
90 | return 'UFGroup'; | |
91 | } | |
92 | ||
6a488035 | 93 | /** |
fe482240 | 94 | * The title for group. |
6a488035 TO |
95 | * |
96 | * @var int | |
6a488035 TO |
97 | */ |
98 | protected $_title; | |
99 | protected $_groupElement; | |
100 | protected $_group; | |
101 | protected $_allPanes; | |
102 | ||
103 | /** | |
fe482240 | 104 | * Set variables up before form is built. |
6a488035 TO |
105 | */ |
106 | public function preProcess() { | |
107 | // current form id | |
108 | $this->_id = $this->get('id'); | |
109 | if (!$this->_id) { | |
110 | $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0); | |
111 | } | |
112 | $this->assign('gid', $this->_id); | |
113 | $this->_group = CRM_Core_PseudoConstant::group(); | |
114 | ||
7df37017 RN |
115 | if ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::DELETE)) { |
116 | $title = CRM_Core_BAO_UFGroup::getTitle($this->_id); | |
117 | $this->assign('profileTitle', $title); | |
118 | } | |
119 | ||
6a488035 TO |
120 | // setting title for html page |
121 | if ($this->_action & CRM_Core_Action::UPDATE) { | |
6a488035 TO |
122 | CRM_Utils_System::setTitle(ts('Profile Settings') . " - $title"); |
123 | } | |
124 | elseif ($this->_action & (CRM_Core_Action::DISABLE | CRM_Core_Action::DELETE)) { | |
125 | $ufGroup['module'] = implode(' , ', CRM_Core_BAO_UFGroup::getUFJoinRecord($this->_id, TRUE)); | |
353ffa53 TO |
126 | $status = 0; |
127 | $status = CRM_Core_BAO_UFGroup::usedByModule($this->_id); | |
6a488035 TO |
128 | if ($this->_action & (CRM_Core_Action::DISABLE)) { |
129 | if ($status) { | |
130 | $message = 'This profile is currently used for ' . $ufGroup['module'] . '. If you disable the profile - it will be removed from these forms and/or modules. Do you want to continue?'; | |
131 | } | |
132 | else { | |
133 | $message = 'Are you sure you want to disable this Profile?'; | |
134 | } | |
135 | } | |
136 | else { | |
137 | if ($status) { | |
138 | $message = 'This profile is currently used for ' . $ufGroup['module'] . '. If you delete the profile - it will be removed from these forms and/or modules. This action cannot be undone. Do you want to continue?'; | |
139 | } | |
140 | else { | |
141 | $message = 'Are you sure you want to delete this Profile? This action cannot be undone.'; | |
142 | } | |
143 | } | |
144 | $this->assign('message', $message); | |
145 | } | |
146 | else { | |
147 | CRM_Utils_System::setTitle(ts('New CiviCRM Profile')); | |
148 | } | |
149 | } | |
150 | ||
151 | /** | |
fe482240 | 152 | * Build the form object. |
6a488035 TO |
153 | * |
154 | * @return void | |
6a488035 TO |
155 | */ |
156 | public function buildQuickForm() { | |
7f3c8b3d | 157 | self::buildQuickEntityForm(); |
6a488035 TO |
158 | if ($this->_action & (CRM_Core_Action::DISABLE | CRM_Core_Action::DELETE)) { |
159 | if ($this->_action & (CRM_Core_Action::DISABLE)) { | |
160 | $display = 'Disable Profile'; | |
161 | } | |
162 | else { | |
163 | $display = 'Delete Profile'; | |
164 | } | |
927f5956 | 165 | $this->addButtons([ |
166 | [ | |
c5c263ca AH |
167 | 'type' => 'next', |
168 | 'name' => $display, | |
169 | 'spacing' => ' ', | |
170 | 'isDefault' => TRUE, | |
927f5956 | 171 | ], |
172 | [ | |
c5c263ca AH |
173 | 'type' => 'cancel', |
174 | 'name' => ts('Cancel'), | |
927f5956 | 175 | ], |
176 | ]); | |
6a488035 TO |
177 | return; |
178 | } | |
6a488035 | 179 | |
6a488035 | 180 | //add checkboxes |
927f5956 | 181 | $uf_group_type = []; |
6a488035 TO |
182 | $UFGroupType = CRM_Core_SelectValues::ufGroupTypes(); |
183 | foreach ($UFGroupType as $key => $value) { | |
184 | $uf_group_type[] = $this->createElement('checkbox', $key, NULL, $value); | |
185 | } | |
186 | $this->addGroup($uf_group_type, 'uf_group_type', ts('Used For'), ' '); | |
187 | ||
188 | // help text | |
5d51a2f9 CW |
189 | $this->add('wysiwyg', 'help_pre', ts('Pre-form Help'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_UFGroup', 'help_post')); |
190 | $this->add('wysiwyg', 'help_post', ts('Post-form Help'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_UFGroup', 'help_post')); | |
6a488035 TO |
191 | |
192 | // weight | |
f20d2b0d | 193 | $this->add('number', 'weight', ts('Order'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_UFJoin', 'weight'), TRUE); |
6a488035 TO |
194 | $this->addRule('weight', ts('is a numeric field'), 'numeric'); |
195 | ||
196 | // is this group active ? | |
197 | $this->addElement('checkbox', 'is_active', ts('Is this CiviCRM Profile active?')); | |
198 | ||
927f5956 | 199 | $paneNames = ['Advanced Settings' => 'buildAdvanceSetting']; |
6a488035 TO |
200 | |
201 | foreach ($paneNames as $name => $type) { | |
202 | if ($this->_id) { | |
203 | $dataURL = "&reset=1&action=update&id={$this->_id}&snippet=4&formType={$type}"; | |
204 | } | |
205 | else { | |
206 | $dataURL = "&reset=1&action=add&snippet=4&formType={$type}"; | |
207 | } | |
208 | ||
927f5956 | 209 | $allPanes[$name] = [ |
210 | 'url' => CRM_Utils_System::url('civicrm/admin/uf/group/setting', $dataURL), | |
6a488035 TO |
211 | 'open' => 'false', |
212 | 'id' => $type, | |
927f5956 | 213 | ]; |
6a488035 | 214 | |
0e6e8724 | 215 | CRM_UF_Form_AdvanceSetting::$type($this); |
6a488035 TO |
216 | } |
217 | ||
927f5956 | 218 | $this->addButtons([ |
219 | [ | |
c5c263ca AH |
220 | 'type' => 'next', |
221 | 'name' => ts('Save'), | |
222 | 'spacing' => ' ', | |
223 | 'isDefault' => TRUE, | |
927f5956 | 224 | ], |
225 | [ | |
c5c263ca AH |
226 | 'type' => 'cancel', |
227 | 'name' => ts('Cancel'), | |
927f5956 | 228 | ], |
229 | ]); | |
6a488035 TO |
230 | |
231 | // views are implemented as frozen form | |
232 | if ($this->_action & CRM_Core_Action::VIEW) { | |
233 | $this->freeze(); | |
927f5956 | 234 | $this->addElement('button', 'done', ts('Done'), ['onclick' => "location.href='civicrm/admin/uf/group?reset=1&action=browse'"]); |
6a488035 TO |
235 | } |
236 | ||
927f5956 | 237 | $this->addFormRule(['CRM_UF_Form_Group', 'formRule'], $this); |
6a488035 TO |
238 | } |
239 | ||
240 | /** | |
c490a46a | 241 | * Set default values for the form. Note that in edit/view mode |
6a488035 TO |
242 | * the default values are retrieved from the database |
243 | * | |
6a488035 TO |
244 | * |
245 | * @return void | |
246 | */ | |
00be9182 | 247 | public function setDefaultValues() { |
927f5956 | 248 | $defaults = []; |
6a488035 TO |
249 | $showHide = new CRM_Core_ShowHideBlocks(); |
250 | ||
251 | if ($this->_action == CRM_Core_Action::ADD) { | |
252 | $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_UFJoin'); | |
253 | } | |
254 | ||
255 | //id fetched for Dojo Pane | |
256 | $pId = CRM_Utils_Request::retrieve('id', 'Positive', $this); | |
257 | if (isset($pId)) { | |
258 | $this->_id = $pId; | |
259 | } | |
260 | ||
261 | if ((isset($this->_id))) { | |
262 | ||
263 | $defaults['weight'] = CRM_Core_BAO_UFGroup::getWeight($this->_id); | |
264 | ||
927f5956 | 265 | $params = ['id' => $this->_id]; |
6a488035 | 266 | CRM_Core_BAO_UFGroup::retrieve($params, $defaults); |
9c1bc317 CW |
267 | $defaults['group'] = $defaults['limit_listings_group_id'] ?? NULL; |
268 | $defaults['add_contact_to_group'] = $defaults['add_to_group_id'] ?? NULL; | |
6a488035 TO |
269 | //get the uf join records for current uf group |
270 | $ufJoinRecords = CRM_Core_BAO_UFGroup::getUFJoinRecord($this->_id); | |
271 | foreach ($ufJoinRecords as $key => $value) { | |
272 | $checked[$value] = 1; | |
273 | } | |
2e1f50d6 | 274 | $defaults['uf_group_type'] = $checked ?? ""; |
6a488035 | 275 | |
6a488035 | 276 | $showAdvanced = 0; |
927f5956 | 277 | $advFields = [ |
353ffa53 TO |
278 | 'group', |
279 | 'post_URL', | |
280 | 'cancel_URL', | |
281 | 'add_captcha', | |
282 | 'is_map', | |
283 | 'is_uf_link', | |
284 | 'is_edit_link', | |
285 | 'is_update_dupe', | |
286 | 'is_cms_user', | |
287 | 'is_proximity_search', | |
927f5956 | 288 | ]; |
6a488035 TO |
289 | foreach ($advFields as $key) { |
290 | if (!empty($defaults[$key])) { | |
291 | $showAdvanced = 1; | |
292 | $this->_allPanes['Advanced Settings']['open'] = 'true'; | |
293 | break; | |
294 | } | |
295 | } | |
296 | } | |
297 | else { | |
b3f1028c | 298 | $defaults['add_cancel_button'] = 1; |
6a488035 TO |
299 | $defaults['is_active'] = 1; |
300 | $defaults['is_map'] = 0; | |
301 | $defaults['is_update_dupe'] = 0; | |
302 | $defaults['is_proximity_search'] = 0; | |
6a488035 TO |
303 | } |
304 | // Don't assign showHide elements to template in DELETE mode (fields to be shown and hidden don't exist) | |
305 | if (!($this->_action & CRM_Core_Action::DELETE) && !($this->_action & CRM_Core_Action::DISABLE)) { | |
306 | $showHide->addToTemplate(); | |
307 | } | |
308 | $this->assign('allPanes', $this->_allPanes); | |
309 | return $defaults; | |
310 | } | |
311 | ||
312 | /** | |
fe482240 | 313 | * Global form rule. |
6a488035 | 314 | * |
5ce1712d TO |
315 | * @param array $fields |
316 | * The input form values. | |
317 | * @param array $files | |
318 | * The uploaded files if any. | |
319 | * @param array $self | |
320 | * Current form object. | |
6a488035 | 321 | * |
72b3a70c CW |
322 | * @return bool|array |
323 | * true if no errors, else array of errors | |
6a488035 | 324 | */ |
00be9182 | 325 | public static function formRule($fields, $files, $self) { |
927f5956 | 326 | $errors = []; |
6a488035 TO |
327 | |
328 | //validate profile title as well as name. | |
329 | $title = $fields['title']; | |
330 | $name = CRM_Utils_String::munge($title, '_', 56); | |
331 | $name .= $self->_id ? '_' . $self->_id : ''; | |
332 | $query = 'select count(*) from civicrm_uf_group where ( name like %1 ) and id != %2'; | |
927f5956 | 333 | $pCnt = CRM_Core_DAO::singleValueQuery($query, [ |
334 | 1 => [$name, 'String'], | |
335 | 2 => [(int) $self->_id, 'Integer'], | |
336 | ]); | |
6a488035 | 337 | if ($pCnt) { |
927f5956 | 338 | $errors['title'] = ts('Profile \'%1\' already exists in Database.', [1 => $title]); |
6a488035 TO |
339 | } |
340 | ||
341 | return empty($errors) ? TRUE : $errors; | |
342 | } | |
343 | ||
344 | /** | |
fe482240 | 345 | * Process the form. |
6a488035 TO |
346 | * |
347 | * @return void | |
6a488035 TO |
348 | */ |
349 | public function postProcess() { | |
350 | if ($this->_action & CRM_Core_Action::DELETE) { | |
351 | $title = CRM_Core_BAO_UFGroup::getTitle($this->_id); | |
352 | CRM_Core_BAO_UFGroup::del($this->_id); | |
927f5956 | 353 | CRM_Core_Session::setStatus(ts("Your CiviCRM Profile '%1' has been deleted.", [1 => $title]), ts('Profile Deleted'), 'success'); |
6a488035 TO |
354 | } |
355 | elseif ($this->_action & CRM_Core_Action::DISABLE) { | |
927f5956 | 356 | $ufJoinParams = ['uf_group_id' => $this->_id]; |
6a488035 TO |
357 | CRM_Core_BAO_UFGroup::delUFJoin($ufJoinParams); |
358 | ||
359 | CRM_Core_BAO_UFGroup::setIsActive($this->_id, 0); | |
360 | } | |
361 | else { | |
362 | // get the submitted form values. | |
927f5956 | 363 | $ids = []; |
6a488035 TO |
364 | $params = $this->controller->exportValues($this->_name); |
365 | ||
366 | if (!array_key_exists('is_active', $params)) { | |
367 | $params['is_active'] = 0; | |
368 | } | |
369 | ||
370 | if ($this->_action & (CRM_Core_Action::UPDATE)) { | |
371 | $ids['ufgroup'] = $this->_id; | |
372 | // CRM-5284 | |
373 | // lets skip trying to mess around with profile weights and allow the user to do as needed. | |
374 | } | |
375 | elseif ($this->_action & CRM_Core_Action::ADD) { | |
376 | $session = CRM_Core_Session::singleton(); | |
377 | $params['created_id'] = $session->get('userID'); | |
378 | $params['created_date'] = date('YmdHis'); | |
379 | } | |
380 | ||
381 | // create uf group | |
382 | $ufGroup = CRM_Core_BAO_UFGroup::add($params, $ids); | |
383 | ||
a7488080 | 384 | if (!empty($params['is_active'])) { |
6a488035 | 385 | //make entry in uf join table |
259ab031 | 386 | CRM_Core_BAO_UFGroup::createUFJoin($params['weight'], $params['uf_group_type'] ?? [], $ufGroup->id); |
6a488035 TO |
387 | } |
388 | elseif ($this->_id) { | |
389 | // this profile has been set to inactive, delete all corresponding UF Join's | |
927f5956 | 390 | $ufJoinParams = ['uf_group_id' => $this->_id]; |
6a488035 TO |
391 | CRM_Core_BAO_UFGroup::delUFJoin($ufJoinParams); |
392 | } | |
393 | ||
394 | if ($this->_action & CRM_Core_Action::UPDATE) { | |
395 | $url = CRM_Utils_System::url('civicrm/admin/uf/group', 'reset=1&action=browse'); | |
927f5956 | 396 | CRM_Core_Session::setStatus(ts("Your CiviCRM Profile '%1' has been saved.", [1 => $ufGroup->title]), ts('Profile Saved'), 'success'); |
6a488035 TO |
397 | } |
398 | else { | |
704f21c0 CW |
399 | // Jump directly to adding a field if popups are disabled |
400 | $action = CRM_Core_Resources::singleton()->ajaxPopupsEnabled ? '' : '/add'; | |
6f231148 | 401 | $url = CRM_Utils_System::url("civicrm/admin/uf/group/field$action", 'reset=1&new=1&gid=' . $ufGroup->id . '&action=' . ($action ? 'add' : 'browse')); |
6a488035 | 402 | CRM_Core_Session::setStatus(ts('Your CiviCRM Profile \'%1\' has been added. You can add fields to this profile now.', |
927f5956 | 403 | [1 => $ufGroup->title] |
353ffa53 | 404 | ), ts('Profile Added'), 'success'); |
6a488035 TO |
405 | } |
406 | $session = CRM_Core_Session::singleton(); | |
407 | $session->replaceUserContext($url); | |
408 | } | |
409 | ||
410 | // update cms integration with registration / my account | |
411 | CRM_Utils_System::updateCategories(); | |
412 | } | |
96025800 | 413 | |
7f3c8b3d | 414 | /** |
415 | * Set the delete message. | |
416 | * | |
417 | * We do this from the constructor in order to do a translation. | |
418 | */ | |
927f5956 | 419 | public function setDeleteMessage() { |
420 | } | |
7f3c8b3d | 421 | |
cbd71f73 | 422 | /** |
423 | * Get the string to display next to the used for field indicating unchangeable uses. | |
424 | * | |
425 | * @return string | |
426 | */ | |
427 | protected function getOtherModuleString() { | |
428 | $otherModules = CRM_Core_BAO_UFGroup::getUFJoinRecord($this->_id, TRUE, TRUE); | |
16a2d251 | 429 | $otherModuleString = NULL; |
cbd71f73 | 430 | if (!empty($otherModules)) { |
cbd71f73 | 431 | foreach ($otherModules as $key) { |
432 | $otherModuleString .= " [ x ] <label>" . $key . "</label>"; | |
433 | } | |
434 | } | |
435 | return $otherModuleString; | |
436 | } | |
437 | ||
6a488035 | 438 | } |