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

Split code from quasi-shared code in order to be able to clean it up #29435

Merged
merged 1 commit into from
Feb 19, 2024

Conversation

eileenmcnaughton
Copy link
Contributor

@eileenmcnaughton eileenmcnaughton commented Feb 19, 2024

Overview

Split code from quasi-shared code in order to be able to clean it up

Before

The core SMS forms call an underlying function which has a confusing signature & is not really suitable to the form's needs, causing the form to be more complex than it need to be

After

The form has it's own copy, allowing the form to be cleaned up - ie it will be able to only generate & pass the needed arrays & we can remove all the pass-by-ref that is making it tough

Soft deprecation added to the underlying function

Technical details

That previously-shared function does not have other core uses but it is is being used externally as a pseudo-api. We should have a real api. Adding that is out of scope but I kept the deprecation pretty soft to reflect that.

Copy link

civibot bot commented Feb 19, 2024

🤖 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 Feb 19, 2024
@eileenmcnaughton eileenmcnaughton changed the title Move permission check from utility function to form layer Split code from quasi-shared code in order to be able to clean it up Feb 19, 2024
The form code is made nasier by the confusing nature of the underlying
function (what parameters does it really want, why are they pass-by-reference)

That function is being used externally as a pseudo-api so this splits off
the forms usage & adds some very soft deprecation to the function.

This will unblock cleaning up the form
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants