3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * form to process actions on the set aspect of Custom Data
21 class CRM_Custom_Form_Group
extends CRM_Core_Form
{
24 * The set id saved to the session for an update.
31 * set is empty or not.
35 protected $_isGroupEmpty = TRUE;
38 * Array of existing subtypes set for a custom set.
42 protected $_subtypes = [];
45 * Set variables up before form is built.
50 public function preProcess() {
51 Civi
::resources()->addScriptFile('civicrm', 'js/jquery/jquery.crmIconPicker.js');
54 $this->_id
= $this->get('id');
56 if ($this->_id
&& $isReserved = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $this->_id
, 'is_reserved', 'id')) {
57 CRM_Core_Error
::statusBounce("You cannot edit the settings of a reserved custom field-set.");
59 // setting title for html page
60 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
61 $title = CRM_Core_BAO_CustomGroup
::getTitle($this->_id
);
62 CRM_Utils_System
::setTitle(ts('Edit %1', [1 => $title]));
64 elseif ($this->_action
== CRM_Core_Action
::VIEW
) {
65 $title = CRM_Core_BAO_CustomGroup
::getTitle($this->_id
);
66 CRM_Utils_System
::setTitle(ts('Preview %1', [1 => $title]));
69 CRM_Utils_System
::setTitle(ts('New Custom Field Set'));
72 if (isset($this->_id
)) {
73 $params = ['id' => $this->_id
];
74 CRM_Core_BAO_CustomGroup
::retrieve($params, $this->_defaults
);
76 $subExtends = $this->_defaults
['extends_entity_column_value'] ??
NULL;
77 if (!empty($subExtends)) {
78 $this->_subtypes
= explode(CRM_Core_DAO
::VALUE_SEPARATOR
, substr($subExtends, 1, -1));
86 * @param array $fields
87 * The input form values.
89 * The uploaded files if any.
94 * true if no errors, else array of errors
96 public static function formRule($fields, $files, $self) {
99 //validate group title as well as name.
100 $title = $fields['title'];
101 $name = CRM_Utils_String
::munge($title, '_', 64);
102 $query = 'select count(*) from civicrm_custom_group where ( name like %1) and id != %2';
103 $grpCnt = CRM_Core_DAO
::singleValueQuery($query, [
104 1 => [$name, 'String'],
105 2 => [(int) $self->_id
, 'Integer'],
108 $errors['title'] = ts('Custom group \'%1\' already exists in Database.', [1 => $title]);
111 if (!empty($fields['extends'][1])) {
112 if (in_array('', $fields['extends'][1]) && count($fields['extends'][1]) > 1) {
113 $errors['extends'] = ts("Cannot combine other option with 'Any'.");
117 if (empty($fields['extends'][0])) {
118 $errors['extends'] = ts("You need to select the type of record that this set of custom fields is applicable for.");
121 $extends = ['Activity', 'Relationship', 'Group', 'Contribution', 'Membership', 'Event', 'Participant'];
122 if (in_array($fields['extends'][0], $extends) && $fields['style'] == 'Tab') {
123 $errors['style'] = ts("Display Style should be Inline for this Class");
124 $self->assign('showStyle', TRUE);
127 if (!empty($fields['is_multiple'])) {
128 $self->assign('showMultiple', TRUE);
131 if (empty($fields['is_multiple']) && $fields['style'] == 'Tab with table') {
132 $errors['style'] = ts("Display Style 'Tab with table' is only supported for multiple-record custom field sets.");
135 //checks the given custom set doesnot start with digit
136 $title = $fields['title'];
137 if (!empty($title)) {
138 // gives the ascii value
139 $asciiValue = ord($title{0});
140 if ($asciiValue >= 48 && $asciiValue <= 57) {
141 $errors['title'] = ts("Name cannot not start with a digit");
145 return empty($errors) ?
TRUE : $errors;
149 * add the rules (mainly global rules) for form.
150 * All local rules are added near the element
156 public function addRules() {
157 $this->addFormRule(['CRM_Custom_Form_Group', 'formRule'], $this);
161 * Build the form object.
166 public function buildQuickForm() {
167 $this->applyFilter('__ALL__', 'trim');
169 $attributes = CRM_Core_DAO
::getAttribute('CRM_Core_DAO_CustomGroup');
172 $this->add('text', 'title', ts('Set Name'), $attributes['title'], TRUE);
174 //Fix for code alignment, CRM-3058
175 $contactTypes = ['Contact', 'Individual', 'Household', 'Organization'];
176 $this->assign('contactTypes', json_encode($contactTypes));
178 $sel1 = ["" => ts("- select -")] + CRM_Core_SelectValues
::customGroupExtends();
180 $activityType = CRM_Core_PseudoConstant
::activityType(FALSE, TRUE, FALSE, 'label', TRUE);
182 $eventType = CRM_Core_OptionGroup
::values('event_type');
183 $grantType = CRM_Core_OptionGroup
::values('grant_type');
184 $campaignTypes = CRM_Campaign_PseudoConstant
::campaignType();
185 $membershipType = CRM_Member_BAO_MembershipType
::getMembershipTypes(FALSE);
186 $participantRole = CRM_Core_OptionGroup
::values('participant_role');
189 asort($activityType);
192 asort($membershipType);
193 asort($participantRole);
195 $sel2['Event'] = $eventType;
196 $sel2['Grant'] = $grantType;
197 $sel2['Activity'] = $activityType;
198 $sel2['Campaign'] = $campaignTypes;
199 $sel2['Membership'] = $membershipType;
200 $sel2['ParticipantRole'] = $participantRole;
201 $sel2['ParticipantEventName'] = CRM_Event_PseudoConstant
::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )");
202 $sel2['ParticipantEventType'] = $eventType;
203 $sel2['Contribution'] = CRM_Contribute_PseudoConstant
::financialType();
204 $sel2['Relationship'] = self
::getRelationshipTypes();
206 $sel2['Individual'] = CRM_Contact_BAO_ContactType
::subTypePairs('Individual', FALSE, NULL);
207 $sel2['Household'] = CRM_Contact_BAO_ContactType
::subTypePairs('Household', FALSE, NULL);
208 $sel2['Organization'] = CRM_Contact_BAO_ContactType
::subTypePairs('Organization', FALSE, NULL);
210 CRM_Core_BAO_CustomGroup
::getExtendedObjectTypes($sel2);
212 foreach ($sel2 as $main => $sub) {
213 if (!empty($sel2[$main])) {
220 $cSubTypes = CRM_Core_Component
::contactSubTypes();
222 if (!empty($cSubTypes)) {
223 $contactSubTypes = [];
224 foreach ($cSubTypes as $key => $value) {
225 $contactSubTypes[$key] = $key;
229 ] +
$contactSubTypes;
232 if (!isset($this->_id
)) {
233 $formName = 'document.forms.' . $this->_name
;
235 $js = "<script type='text/javascript'>\n";
236 $js .= "{$formName}['extends_1'].style.display = 'none';\n";
238 $this->assign('initHideBlocks', $js);
242 $sel = &$this->add('hierselect',
246 'name' => 'extends[0]',
247 'style' => 'vertical-align: top;',
251 $sel->setOptions([$sel1, $sel2]);
252 if (is_a($sel->_elements
[1], 'HTML_QuickForm_select')) {
253 // make second selector a multi-select -
254 $sel->_elements
[1]->setMultiple(TRUE);
255 $sel->_elements
[1]->setSize(5);
257 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
258 $subName = $this->_defaults
['extends_entity_column_id'] ??
NULL;
259 if ($this->_defaults
['extends'] == 'Participant') {
261 $this->_defaults
['extends'] = 'ParticipantRole';
263 elseif ($subName == 2) {
264 $this->_defaults
['extends'] = 'ParticipantEventName';
266 elseif ($subName == 3) {
267 $this->_defaults
['extends'] = 'ParticipantEventType';
271 //allow to edit settings if custom set is empty CRM-5258
272 $this->_isGroupEmpty
= CRM_Core_BAO_CustomGroup
::isGroupEmpty($this->_id
);
273 if (!$this->_isGroupEmpty
) {
274 if (!empty($this->_subtypes
)) {
275 // we want to allow adding / updating subtypes for this case,
276 // and therefore freeze the first selector only.
277 $sel->_elements
[0]->freeze();
280 // freeze both the selectors
284 $this->assign('isCustomGroupEmpty', $this->_isGroupEmpty
);
285 $this->assign('gid', $this->_id
);
287 $this->assign('defaultSubtypes', json_encode($this->_subtypes
));
290 $this->add('wysiwyg', 'help_pre', ts('Pre-form Help'), $attributes['help_pre']);
291 $this->add('wysiwyg', 'help_post', ts('Post-form Help'), $attributes['help_post']);
294 $this->add('number', 'weight', ts('Order'), $attributes['weight'], TRUE);
295 $this->addRule('weight', ts('is a numeric field'), 'numeric');
298 $this->add('select', 'style', ts('Display Style'), CRM_Core_SelectValues
::customGroupStyle());
300 $this->add('text', 'icon', ts('Tab icon'), ['class' => 'crm-icon-picker', 'allowClear' => TRUE]);
302 // is this set collapsed or expanded ?
303 $this->addElement('advcheckbox', 'collapse_display', ts('Collapse this set on initial display'));
305 // is this set collapsed or expanded ? in advanced search
306 $this->addElement('advcheckbox', 'collapse_adv_display', ts('Collapse this set in Advanced Search'));
308 // is this set active ?
309 $this->addElement('advcheckbox', 'is_active', ts('Is this Custom Data Set active?'));
311 //Is this set visible on public pages?
312 $this->addElement('advcheckbox', 'is_public', ts('Is this Custom Data Set public?'));
314 // does this set have multiple record?
315 $multiple = $this->addElement('advcheckbox', 'is_multiple',
316 ts('Does this Custom Field Set allow multiple records?'), NULL);
318 // $min_multiple = $this->add('text', 'min_multiple', ts('Minimum number of multiple records'), $attributes['min_multiple'] );
319 // $this->addRule('min_multiple', ts('is a numeric field') , 'numeric');
321 $max_multiple = $this->add('text', 'max_multiple', ts('Maximum number of multiple records'), $attributes['max_multiple']);
322 $this->addRule('max_multiple', ts('is a numeric field'), 'numeric');
324 //allow to edit settings if custom set is empty CRM-5258
325 $this->assign('isGroupEmpty', $this->_isGroupEmpty
);
326 if (!$this->_isGroupEmpty
) {
328 //$min_multiple->freeze();
329 $max_multiple->freeze();
332 $this->assign('showStyle', FALSE);
333 $this->assign('showMultiple', FALSE);
337 'name' => ts('Save'),
338 'spacing' => ' ',
343 'name' => ts('Cancel'),
346 if (!$this->_isGroupEmpty
&& !empty($this->_subtypes
)) {
347 $buttons[0]['class'] = 'crm-warnDataLoss';
349 $this->addButtons($buttons);
351 // TODO: Is this condition ever true? Can this code be removed?
352 if ($this->_action
& CRM_Core_Action
::VIEW
) {
354 $this->addElement('xbutton', 'done', ts('Done'), [
356 'onclick' => "location.href='civicrm/admin/custom/group?reset=1&action=browse'",
362 * Set default values for the form. Note that in edit/view mode
363 * the default values are retrieved from the database
367 * array of default values
369 public function setDefaultValues() {
370 $defaults = &$this->_defaults
;
371 $this->assign('showMaxMultiple', TRUE);
372 if ($this->_action
== CRM_Core_Action
::ADD
) {
373 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_CustomGroup');
375 $defaults['is_multiple'] = $defaults['min_multiple'] = 0;
376 $defaults['is_active'] = $defaults['is_public'] = $defaults['collapse_display'] = 1;
377 $defaults['style'] = 'Inline';
379 elseif (empty($defaults['max_multiple']) && !$this->_isGroupEmpty
) {
380 $this->assign('showMaxMultiple', FALSE);
383 if (($this->_action
& CRM_Core_Action
::UPDATE
) && !empty($defaults['is_multiple'])) {
384 $defaults['collapse_display'] = 0;
387 if (isset($defaults['extends'])) {
388 $extends = $defaults['extends'];
389 unset($defaults['extends']);
391 $defaults['extends'][0] = $extends;
393 if (!empty($this->_subtypes
)) {
394 $defaults['extends'][1] = $this->_subtypes
;
397 $defaults['extends'][1] = [0 => ''];
400 if ($extends == 'Relationship' && !empty($this->_subtypes
)) {
401 $relationshipDefaults = [];
402 foreach ($defaults['extends'][1] as $donCare => $rel_type_id) {
403 $relationshipDefaults[] = $rel_type_id;
406 $defaults['extends'][1] = $relationshipDefaults;
419 public function postProcess() {
420 // get the submitted form values.
421 $params = $this->controller
->exportValues('Group');
422 $params['overrideFKConstraint'] = 0;
423 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
424 $params['id'] = $this->_id
;
425 if ($this->_defaults
['extends'][0] != $params['extends'][0]) {
426 $params['overrideFKConstraint'] = 1;
429 if (!empty($this->_subtypes
)) {
430 $subtypesToBeRemoved = [];
431 $subtypesToPreserve = $params['extends'][1];
432 // Don't remove any value if group is extended to -any- subtype
433 if (!empty($subtypesToPreserve[0])) {
434 $subtypesToBeRemoved = array_diff($this->_subtypes
, array_intersect($this->_subtypes
, $subtypesToPreserve));
436 CRM_Contact_BAO_ContactType
::deleteCustomRowsOfSubtype($this->_id
, $subtypesToBeRemoved, $subtypesToPreserve);
439 elseif ($this->_action
& CRM_Core_Action
::ADD
) {
440 //new custom set , so lets set the created_id
441 $session = CRM_Core_Session
::singleton();
442 $params['created_id'] = $session->get('userID');
443 $params['created_date'] = date('YmdHis');
446 $group = CRM_Core_BAO_CustomGroup
::create($params);
449 Civi
::cache('fields')->flush();
450 // reset ACL and system caches.
451 CRM_Core_BAO_Cache
::resetCaches();
453 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
454 CRM_Core_Session
::setStatus(ts('Your custom field set \'%1 \' has been saved.', [1 => $group->title
]), ts('Saved'), 'success');
457 // Jump directly to adding a field if popups are disabled
458 $action = CRM_Core_Resources
::singleton()->ajaxPopupsEnabled ?
'' : '/add';
459 $url = CRM_Utils_System
::url("civicrm/admin/custom/group/field$action", 'reset=1&new=1&gid=' . $group->id
. '&action=' . ($action ?
'add' : 'browse'));
460 CRM_Core_Session
::setStatus(ts("Your custom field set '%1' has been added. You can add custom fields now.",
462 ), ts('Saved'), 'success');
463 $session = CRM_Core_Session
::singleton();
464 $session->replaceUserContext($url);
467 // prompt Drupal Views users to update $db_prefix in settings.php, if necessary
469 $config = CRM_Core_Config
::singleton();
470 if (is_array($db_prefix) && $config->userSystem
->is_drupal
&& module_exists('views')) {
471 // get table_name for each custom group
473 $sql = "SELECT table_name FROM civicrm_custom_group WHERE is_active = 1";
474 $result = CRM_Core_DAO
::executeQuery($sql);
475 while ($result->fetch()) {
476 $tables[$result->table_name
] = $result->table_name
;
479 // find out which tables are missing from the $db_prefix array
480 $missingTableNames = array_diff_key($tables, $db_prefix);
482 if (!empty($missingTableNames)) {
483 CRM_Core_Session
::setStatus(ts("To ensure that all of your custom data groups are available to Views, you may need to add the following key(s) to the db_prefix array in your settings.php file: '%1'.",
484 [1 => implode(', ', $missingTableNames)]
485 ), ts('Note'), 'info');
491 * Return a formatted list of relationship labels.
494 * Array (int $id => string $label).
496 public static function getRelationshipTypes() {
497 // Note: We include inactive reltypes because we don't want to break custom-data
498 // UI when a reltype is disabled.
499 return CRM_Core_DAO
::executeQuery('
503 WHEN label_a_b is not null AND label_b_a is not null AND label_a_b != label_b_a
504 THEN concat(label_a_b, \' / \', label_b_a)
505 WHEN label_a_b is not null
507 WHEN label_b_a is not null
509 ELSE concat("RelType #", id)
511 FROM civicrm_relationship_type
513 )->fetchMap('id', 'label');