Skip to content

Check for null in sanitize_embedded_shortcodes#2074

Merged
Crabcyborg merged 1 commit into
masterfrom
check_for_null_in_sanitize_embedded_shortcodes
Oct 25, 2024
Merged

Check for null in sanitize_embedded_shortcodes#2074
Crabcyborg merged 1 commit into
masterfrom
check_for_null_in_sanitize_embedded_shortcodes

Conversation

@Crabcyborg
Copy link
Copy Markdown
Contributor

@Crabcyborg Crabcyborg commented Oct 25, 2024

Related ticket https://secure.helpscout.net/conversation/2744881693/213579?

They didn't include a full message, but if I pass null to $subject, I get this message (in PHP 8.3) which matches what they sent.

Deprecated: str_replace(): Passing null to parameter #3 ($subject) of type array|string is deprecated

This is called in various places. Rather than trying to handle the null check everywhere this is called, it's easier to just put a null check in this function.

If the value is null, we don't need to modify it in this function.

Pre-release
formidable-6.16.1b.zip

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 25, 2024

Walkthrough

The changes made in this pull request focus on the FrmFieldsHelper class, specifically the sanitize_embedded_shortcodes method. The method's parameter type has been updated to accept null values, and a null check has been introduced to prevent processing when the value is null. Additionally, documentation comments have been revised to reflect these changes, enhancing clarity and type safety.

Changes

File Path Change Summary
classes/helpers/FrmFieldsHelper.php - Updated sanitize_embedded_shortcodes method to accept `string

Possibly related PRs


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 80214bf and 941c23c.

📒 Files selected for processing (1)
  • classes/helpers/FrmFieldsHelper.php (1 hunks)
🔇 Additional comments (2)
classes/helpers/FrmFieldsHelper.php (2)

946-948: LGTM! Clear and accurate parameter documentation.

The docblock clearly documents the parameter types, including the new string|null type for the $value parameter.


951-954: LGTM! Well-implemented null check.

The null check is:

  • Placed early in the method (fail fast)
  • Cleanly implemented with consistent formatting
  • Helps centralize null handling instead of checking at each call site

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.

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 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 merged commit e5d9f16 into master Oct 25, 2024
@Crabcyborg Crabcyborg deleted the check_for_null_in_sanitize_embedded_shortcodes branch October 25, 2024 14:21
@coderabbitai coderabbitai Bot mentioned this pull request Oct 29, 2024
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