Fix incorrect type hint in docblocks for getOr and getOrSend methods

[mrmmg]

This pull request updates the docblocks of the getOr and getOrSend methods to reflect the correct type hinting.

✔ Changes:

I updated the @param annotation for $default and $callable to include an array in addition to a string.

This ensures that the documentation aligns with the expected parameter types, improving code clarity and maintainability.

This change helps IDEs suggest code better by providing more accurate type hints.

No functional changes were made to the code. this is a documentation fix only.

Summary by CodeRabbit

• New Features
  • Expanded input support for key configurations, allowing both string and array values. This improvement provides greater flexibility when setting default values and handling operations.

[coderabbitai]

Walkthrough

The pull request updates the method signatures in the src/Nullable.php file. The changes modify the type hints for parameters in two methods: getOr and getOrSend, allowing them to accept either a string or an array instead of a string exclusively. This adjustment enhances the flexibility of the API while keeping the core functionality intact.

Changes

File	Change Summary
src/Nullable.php	Updated parameter type hints: In getOr, changed $default from string to `string

Poem

I'm a bunny coding under moonlit skies,
Changing types and sharing joyful sighs.
Strings and arrays now frolic side by side,
A flexible feature where both can reside.
Hop along with me on this coding ride!

✨ Finishing Touches

• 📝 Generate Docstrings

---

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>, 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 generate docstrings to generate docstrings for 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/Nullable.php (1)

35-35: Type hint improvement is appropriate but could be more comprehensive.

The change from @param string $default to @param string|array $default is indeed more accurate since the getOr method can accept both a string and an array as the default value. This is verified by the implementation at line 46-50 where it checks if $default is callable (which can be a string function name or an array with class/method) and otherwise returns it directly.

However, the type hint could be even more comprehensive as $default can actually be of any type (not just string or array) that would be returned if the predicate returns true.

For even better IDE support, consider updating to @param mixed $default to reflect that any type can be used.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1e0105d and ff413a6.

📒 Files selected for processing (1)

• src/Nullable.php (2 hunks)

🔇 Additional comments (1)

src/Nullable.php (1)

75-75: Type hint improvement is appropriate.

The change from @param string $callable to @param string|array $callable improves accuracy as PHP callables can be:

• A string containing a function name
• An array containing an object and method name
• An array containing a class name and static method

This modification aligns with the implementation at line 86-88 where is_callable() is used to validate the parameter, and with line 98 which references providing "a valid http response or a callable".