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

Use writeRecord from mailing job DAO #29135

Merged
merged 2 commits into from
Jan 29, 2024

Conversation

eileenmcnaughton
Copy link
Contributor

Overview

Use writeRecord from mailing job DAO

Before

Function has it's own special code

After

Function is generic

Technical Details

I took a look at the commit that added the hook in & it was tidy up - not any particular use case & I searched for 'MailingJob' in universe & didn't find any hook implementations. So I think it's Ok to move the hook order slightly. Logically it would be bad to rely on that function being called before the hook since we are moving to NOT letting that function be called in MailingJob::create()

Comments

Copy link

civibot bot commented Jan 29, 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 Jan 29, 2024
@@ -40,20 +40,11 @@ class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob {
* @return \CRM_Mailing_BAO_MailingJob
* @throws \CRM_Core_Exception
*/
public static function create($params) {
if (empty($params['id']) && empty($params['mailing_id'])) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is a required field so the parent will handle this fine

@colemanw
Copy link
Member

@eileenmcnaughton this looks good but typically when doing this we also add a @deprecated annotation to the create() function.

@eileenmcnaughton
Copy link
Contributor Author

@colemanw OK - I added that - in this case it is good that neither apv3 or apv4 will call create anymore so that seems right - I guess I can remove part of #29138 that passes the skip parameter

@colemanw colemanw merged commit 2cfb362 into civicrm:master Jan 29, 2024
3 checks passed
@eileenmcnaughton eileenmcnaughton deleted the use_write branch January 29, 2024 20:56
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