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] use common helper to set expected keys for tabs in Summary.tpl and TabHeader.tpl #31636

Merged
merged 1 commit into from
Dec 19, 2024

Conversation

ufundo
Copy link
Contributor

@ufundo ufundo commented Dec 19, 2024

Overview

Consolidate and more tightly target the preprocessing of tabs arrays before they are passed to smarty templates.

Before

  • TabHeader.tpl and Contact summary tabs in Summary.tpl handle the issue of ensuring the expected smarty vars are assigned slightly differently
  • The TabHeader way is also called for every single page and form load regardless of whether there are any tabs on the page/form.

After

  • a common helper function is used to set expected array keys
  • the function is used at the point of assigning the tabs variable, rather than on every page/form load

Comments

This should help with avoiding any ENOTICEs caused by #31606

Copy link

civibot bot commented Dec 19, 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 🔗

@ufundo
Copy link
Contributor Author

ufundo commented Dec 19, 2024

To note: I would really like to consolidate these two templates to use a single one. Slightly tricky because of some weird discrepancies with e.g. active and id - but hope this is a step in the right direction.

@colemanw colemanw merged commit c6a3332 into civicrm:master Dec 19, 2024
1 check passed
@colemanw
Copy link
Member

Looks good, thanks @ufundo

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