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.

Sign up for GitHub

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

Jump to bottom

Simplify params to legacyProcessMembership #32224

Merged
merged 1 commit into from
Feb 27, 2025
Merged

Simplify params to legacyProcessMembership #32224

merged 1 commit into from
Feb 27, 2025

Conversation

mattwire
Copy link
Contributor

Overview

This just simplifies one of the parameters to CRM_Contribution_Form_Confirm::legacyProcessMembership() so it's easier to read/refactor.

Before

array passed in containing campaign_id

After

campaign_id passed in directly

Technical Details

Comments

@civibot civibot
Copy link

civibot bot commented Feb 26, 2025

🤖 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 26, 2025
@mattwire mattwire mentioned this pull request Feb 27, 2025
Open
mattwire
mattwire commented Feb 27, 2025
View reviewed changes
CRM/Contribute/Form/Contribution/Confirm.php Outdated
@@ -1497,7 +1494,9 @@ protected function postProcessMembership(
date('YmdHis'), $membershipParams['cms_contactID'] ?? NULL,
$customFieldsFormatted,
$numTerms, $membershipID, $pending,
$contributionRecurID, $membershipSource, $isPayLater, $memParams, $membershipContribution,
$contributionRecurID, $membershipSource, $isPayLater,
$this->_params['campaign_id'] ?? ($this->_values['campaign_id'] ?? NULL),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Transferring comment from @eileenmcnaughton from #32222:

Could probably even ditch it & use $this->getContributionPageValue('campaign_id') in the next function down - or do we think it might be possible to have campaign_id in a profile (probably they would do something weird & prefix it anyway :-)) - if so then the next level down could still do

$this->getSubmittedValue('campaign_id') ?: $this->getContributionPageValue('campaign_id')

I'm pretty sure I fixed these pages so that getSubmittedValue() also works on the Confirm page

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@eileenmcnaughton Hmm, ok I looked into this and you are probably right but it would require quite a bit more debugging / testing than I have time to do right now because campaign_id does get set/changed in a few places.
I've updated the PR and left a comment to help the next person :-) Can we merge as-is?

@mattwire mattwire force-pushed the legacyparamssimplify branch from dc67e94 to 27f64ba Compare February 27, 2025 11:57
demeritcowboy
demeritcowboy reviewed Feb 27, 2025
View reviewed changes
CRM/Contribute/Form/Contribution/Confirm.php
@@ -2675,14 +2677,14 @@ public static function unitTestAccessTolegacyProcessMembership($contactID, $memb
* @param int $contributionRecurID
* @param $membershipSource
* @param $isPayLater
* @param array $memParams
* @param int? $campaignID
Copy link
Contributor

Choose a reason for hiding this comment

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

Like on the line below it would be int|null but not worth holding it up.

@demeritcowboy demeritcowboy merged commit 639d0a0 into civicrm:master Feb 27, 2025
1 check passed
@mattwire mattwire deleted the legacyparamssimplify branch February 27, 2025 17:40
@mattwire
Copy link
Contributor Author

Thanks @demeritcowboy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@demeritcowboy demeritcowboy demeritcowboy left review comments

Assignees
No one assigned
Labels
master
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mattwire @demeritcowboy