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] Minor cleanup in CiviMail #31813

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

semseysandor
Copy link
Contributor

Overview

  • Remove unused local variables, block of code
  • Remove deprecated CRM_Mailing_BAO_Mailing::getGroupNames (scheduled for removal: around 5.77)
  • add missing throws tags
  • use Civi::log()->error instead of CRM_Core_Error::debug_log_message

Copy link

civibot bot commented Jan 17, 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 Jan 17, 2025
* Return a list of group names for this mailing. Does not work with
* prior-mailing targets.
*
* @deprecated since 5.71 will be removed around 5.77
Copy link
Member

@totten totten Jan 17, 2025

Choose a reason for hiding this comment

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

Looking for callers, I see:

  • getGroupNames is called by...
    • CRM_Utils_Token::getMailingTokenReplacement , which is called by:
      • CRM_Mailing_Tokens::evaluateToken(), and...
      • CRM_Utils_Token::replaceMailingTokens(), which is called by:
        • CRM_SMS_Form_Upload, and...
        • CRM_Mailing_Event_BAO_MailingEventResubscribe

(edited to use nested layout)

It might be that...

  • The code-paths are dead for other/higher-level reason (in which case more can be cleaned), or....
  • These specific callers lack test-coverage for the {mailing.group} token.

Copy link
Member

Choose a reason for hiding this comment

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

This deprecation was suggested in f31f94b. @eileenmcnaughton, does this actually look safe to remove?

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