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

[REF][PHP8.2] Declare property _amount on event confirm form #28766

Closed
wants to merge 1 commit into from

Conversation

braders
Copy link
Contributor

@braders braders commented Dec 21, 2023

Overview

Declare property _amount on event confirm form

Before

Test failures on PHP 8.2, for example:

CRM_Event_Form_Registration_ConfirmTest::testNoCalendarLinks
Creation of dynamic property CRM_Event_Form_Registration_Confirm::$_amount is deprecated

After

Property declared.

Technical Details

I'd assumed that _amount would be deeply interwined amongst multiple classes, but once I dug into it, that turned out not to be the case.

That said, this property is fairly confusing. Elsewhere in Civi, _amount is a float (e.g. in CRM_Contribute_Form_Contribution_Confirm). However, here it's an array, and there is is no overlap between these different types of _amount.

Just to further confuse things, the deprecated testSubmit() sets _amount to a number, which works because _amount is largely used as a truthy check in if statements. However, testSubmit() is deprecated, so I don't think it matters to much.

I have added a comment to the code explaining this confusion, and in time moving to getter functions probably makes sense. In the meantime this gets us closer to PHP 8.2 support.

@eileenmcnaughton This relates to this PR from a couple of days ago, so worth you taking a look at this.

Copy link

civibot bot commented Dec 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 Dec 21, 2023
@eileenmcnaughton
Copy link
Contributor

@braders I guess this gets us past the fails but I think I'd rather it was tagged deprecated & the comment said something more like - this property is going to be changed or removed so if you access it your code will break

@eileenmcnaughton
Copy link
Contributor

@braders I actually think we should go full private on this one - it is the wrong property doing the wrong thing in the wrong place & it actively makes the code harder to maintain. There has never been a commitment to maintain all non-api properties on form classes & especially not ones with no definition. I guess I have one thought about how to deprecate it -I'll have a go at that...

@eileenmcnaughton
Copy link
Contributor

@braders what about this ? #28769

@eileenmcnaughton
Copy link
Contributor

Closing this as the alternate was merged

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