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] dev/core#5803 CRM_Utils_System::theme - split out maintenance calls #32429

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ufundo
Copy link
Contributor

@ufundo ufundo commented Mar 20, 2025

Overview

A small step to cleaning up strange theme function. Acting on quixotic 10 year old todo message.

Before

  • theme function has two additional params for $print and $maintenance
  • it's called in 3 places in core with $maintenance = TRUE
  • handling for $maintenance = TRUE and $print = [truthy] looks haphazard
  • looks like callers to theme expect a return value to echo - but in most cases theme just prints itself and returns nothing

After

  • split out calls with $maintenance = TRUE to a separate function with a well-defined signature
  • add deprecation notices to unexpected calls to theme

Comments

Inscrutability here didn't help when trying to work on #32398

Copy link

civibot bot commented Mar 20, 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 Mar 20, 2025
@ufundo
Copy link
Contributor Author

ufundo commented Mar 20, 2025

Maybe worth noting: previously calls to theme with $maintenance = TRUE led to exit() being called. That's not forced by renderMaintenanceMessage, which just returns the rendered content. As far as I can see nothing else happens after renderMaintenanceMessage in any of the callers, so they should just exit cleanly anyway.

@ufundo ufundo marked this pull request as ready for review March 20, 2025 22:41
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.

1 participant