Reduce file scope of some phpstan exceptions

[Crabcyborg]

This update changes a lot of global exceptions so they only apply to a couple of problematic files.

[coderabbitai]

Walkthrough

The pull request introduces modifications to the phpstan.neon configuration file, specifically enhancing error message patterns related to static analysis checks. New patterns are added for issues such as unused parameters, invalid types, and array key types. Some existing patterns are removed, indicating a refined focus on more relevant issues. The changes aim to improve the specificity and robustness of type checking and error reporting across various classes and methods in the codebase.

Changes

Files	Change Summary
phpstan.neon	Added multiple error message patterns for unused parameters, invalid types, array key types, and specific method calls. Removed some existing patterns to focus on more relevant issues.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PHPStan
    participant Codebase

    User->>PHPStan: Run static analysis
    PHPStan->>Codebase: Analyze code for errors
    Codebase-->>PHPStan: Return analysis results
    PHPStan->>User: Display error messages based on new patterns

Loading

Tip

New features

Walkthrough comment now includes:

• Possibly related PRs: A list of potentially related PRs to help you recall past context.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

• Please share any feedback in the discussion post on our Discord.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 75c073d and 4ae0272.

Files selected for processing (1)

• phpstan.neon (1 hunks)

Additional comments not posted (10)

phpstan.neon (10)

54-59: Refinement of PHPStan checks for unused parameters.

The addition of specific paths for the error pattern related to unused parameters (#has an unused parameter#) is a positive change. It narrows down the scope of this check to only the files where it's most relevant, potentially reducing noise in PHPStan reports and focusing developer attention on significant issues.

---

61-62: Targeted check for invalid types.

Adding a specific path (stubs.php) for the error pattern #has invalid type# helps in focusing the static analysis efforts on areas of the codebase that might be prone to type-related issues. This is a strategic enhancement to the configuration that should improve the accuracy and relevance of PHPStan's output.

---

64-67: Enhanced checking for array key types.

The inclusion of paths for the error pattern #Possibly invalid array key type# targets specific helper classes that likely deal with complex data structures. This change should help catch subtle bugs related to array key types early in the development process.

---

69-73: Specific method expectations clarified.

The addition of error patterns for get_mailer() and return types in FrmSMTPController.php (lines 69-73) indicates a focus on ensuring that method calls and return types in this controller are correctly implemented. This is crucial for maintaining the reliability of email-related functionalities in the application.

---

75-76: Check for unused 'use' statements.

The pattern #has an unused use# added for classes/views/styles/manage.php is an excellent way to keep the code clean from unnecessary imports, which can reduce confusion and improve maintainability.

---

78-81: Handling mixed type offsets.

The pattern #Cannot access an offset on mixed.# added for paths involving form and entry metadata handling (lines 78-81) is a proactive measure to ensure robust data handling and prevent runtime errors in dynamic type scenarios.

---

83-84: Constructor method check for FrmFieldName.

Specifying the check for the constructor of FrmFieldName (line 83-84) helps ensure that the initialization of this model adheres to expected types and parameters, which is vital for data integrity and application stability.

---

86-87: Autoload function callback type expectations.

The addition of a specific message for the callback of spl_autoload_register in formidable.php (line 86-87) helps ensure that autoload implementations meet the expected type standards, which is crucial for the correct loading of classes and interfaces.

---

89-90: Undefined method check for FrmFieldType.

Adding a check for an undefined method call on FrmFieldType (line 89-90) is a critical update to catch potentially breaking changes or incorrect method calls in the codebase, which could affect form field functionality.

---

92-93: Array destructuring type safety.

The new pattern #Cannot use array destructuring on# added for classes/helpers/FrmStylesHelper.php (line 92-93) is a valuable addition to ensure that destructuring is used safely and appropriately, preventing type-related errors.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.