Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Permit multi-record custom field sets to extend any entity (in theory) #27549

Merged
merged 1 commit into from
Sep 27, 2023

Conversation

colemanw
Copy link
Member

@colemanw colemanw commented Sep 21, 2023

Overview

Permits any entity to have multi-record custom field sets, by improving the underlying metadata.

Before

Multi-record custom sets were hardcoded in multiple places as "Contact only".
Crufty form for saving custom fieldsets.

After

Metadata exists about which entities support multi-record custom sets. This is still only enabled for contacts, but now the switch could be flipped for other entities.
Refactors the custom group form to be metadata-driven & respect the new setting (and cleanup lots of cruft). UX much nicer.

Comments

The motivation was to improve metadata, but it turned into a big cleanup project.

@civibot
Copy link

civibot bot commented Sep 21, 2023

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers...

➡️ Online demo of this PR 🔗

@civibot civibot bot added the master label Sep 21, 2023
Comment on lines -334 to -341
if ($extends == 'Relationship' && !empty($this->_subtypes)) {
$relationshipDefaults = [];
foreach ($defaults['extends'][1] as $donCare => $rel_type_id) {
$relationshipDefaults[] = $rel_type_id;
}

$defaults['extends'][1] = $relationshipDefaults;
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is why the PR manages to add functionality and metadata while not overall increasing SLOC. I deleted a bunch of code like this which:

  1. Does nothing.
  2. Has done nothing for over a decade.
  3. Looks scary so everyone was afraid to touch it.

@seamuslee001
Copy link
Contributor

@colemanw this seems to mostly work. I did find one issue which is I was just testing changing the Entity type around and if I selected Participants, then elected Role or Event name or some sub. Then changed the entity to be Contacts the extends select box still shows

contact-custom-options

…i-record custom fields

This is still only enabled for contacts, but now the switch could be flipped for other entities.
Refactors the custom group form to be metadata-driven & respect the new setting (and cleanup lots of cruft).
@colemanw
Copy link
Member Author

Thanks @seamuslee001 - fixed now.

@colemanw colemanw force-pushed the customFields branch 2 times, most recently from a641291 to 0129a2e Compare September 27, 2023 00:25
@seamuslee001
Copy link
Contributor

ok seems to work correctly now on my local merging

@seamuslee001 seamuslee001 merged commit bc7a37d into civicrm:master Sep 27, 2023
@seamuslee001 seamuslee001 deleted the customFields branch September 27, 2023 00:51
@colemanw colemanw changed the title CustomGroup - Add metadata, cleanup "Custom FieldSet" form & improve UX Permit multi-record custom field sets to extend any entity (in theory) Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants