Skip to content

Make unread inbox count checks more consistent#2354

Closed
Crabcyborg wants to merge 1 commit into
masterfrom
make_unread_inbox_count_checks_more_consistent
Closed

Make unread inbox count checks more consistent#2354
Crabcyborg wants to merge 1 commit into
masterfrom
make_unread_inbox_count_checks_more_consistent

Conversation

@Crabcyborg
Copy link
Copy Markdown
Contributor

@Crabcyborg Crabcyborg commented May 9, 2025

This way it's all happening in one place. It's easier for testing and will be easier if we end up changing the count when there isn't a new inbox item (ie. for sales).

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 9, 2025

Walkthrough

The changes refactor how unread inbox counts are retrieved in the codebase. A new method, get_unread_count(), is introduced in the FrmInbox class, and existing code in both FrmEntriesHelper and FrmInbox is updated to use this method instead of directly counting unread items.

Changes

File(s) Change Summary
classes/helpers/FrmEntriesHelper.php Refactored to use $inbox->get_unread_count() instead of count($inbox->unread()) for unread counts.
classes/models/FrmInbox.php Added get_unread_count() method; updated unread_html() to use this new method for counting.

Possibly related PRs

  • Strategy11/formidable-forms#2225: Also modifies FrmEntriesHelper::get_visible_unread_inbox_count() but with a different approach, focusing on logic simplification and Pro settings integration.
  • Strategy11/formidable-forms#2214: Introduces get_unread_count() and updates related classes to use this method, directly connecting to the refactor in this PR.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9f6918c and 2f67b77.

📒 Files selected for processing (2)
  • classes/helpers/FrmEntriesHelper.php (1 hunks)
  • classes/models/FrmInbox.php (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
classes/helpers/FrmEntriesHelper.php (1)
classes/models/FrmInbox.php (1)
  • get_unread_count (344-346)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: PHP 8 tests in WP trunk
  • GitHub Check: Cypress
  • GitHub Check: PHP 7.4 tests in WP trunk
  • GitHub Check: Cypress
  • GitHub Check: PHP 7.4 tests in WP trunk
  • GitHub Check: PHP 8 tests in WP trunk
🔇 Additional comments (3)
classes/models/FrmInbox.php (2)

318-318: Good refactoring to use the new dedicated method.

This change improves maintainability by using the newly created get_unread_count() method instead of directly using count($this->unread()).


337-346: Good addition of a dedicated method for retrieving unread count.

Creating this dedicated method centralizes the unread count retrieval logic, making the code more maintainable and following better OOP principles. If the counting logic needs to change in the future, it will only need to be updated in one place.

classes/helpers/FrmEntriesHelper.php (1)

882-882: Good refactoring to use the centralized method.

This change improves consistency by using the new get_unread_count() method instead of directly calling count($inbox->unread()). This aligns with the changes in the FrmInbox class and ensures that unread inbox counts are retrieved in a consistent manner throughout the codebase.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Crabcyborg Crabcyborg closed this May 9, 2025
@Crabcyborg Crabcyborg removed this from the 6.21 milestone May 9, 2025
@Crabcyborg Crabcyborg deleted the make_unread_inbox_count_checks_more_consistent branch May 9, 2025 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant