Skip to content

add mixed return type #727

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add mixed return type #727

wants to merge 2 commits into from

Conversation

tacman
Copy link

@tacman tacman commented Feb 23, 2025

Pull Request

Related issue

Fixes #726

What does this PR do?

Gets rid of the deprecation notice. But I forget when 'mixed' was introduced and if this library is supporting a version of php that doesn't allow this.

Summary by CodeRabbit

  • Refactor
    • Updated method signature to explicitly declare a return type, improving code clarity and compatibility. No changes to user-facing behavior.

@norkunas
Copy link
Collaborator

Would it work to resolve deprecation adding only phpdoc return typehint?

@tacman
Copy link
Author

tacman commented Feb 23, 2025

Probably. I see that 'mixed' is PHP 8 only.

PHP 7.4 reached EOL in 2022. What about simply bumping a new release and taking advantage of all the PHP 8 goodness?

@Strift Strift closed this May 14, 2025
@Strift Strift reopened this May 14, 2025
Copy link

coderabbitai bot commented May 14, 2025

Walkthrough

The offsetGet method in the Data class was updated to declare a native return type of mixed, replacing the previous usage of the #[\ReturnTypeWillChange] attribute. The method's internal logic remains unchanged.

Changes

File(s) Change Summary
src/Contracts/Data.php Updated offsetGet method signature to include a mixed return type.

Assessment against linked issues

Objective Addressed Explanation
Add mixed return type to offsetGet in Meilisearch\Contracts\Data to resolve deprecation (#726)

Poem

A hop and a skip, a type we now fix,
No more deprecation, no more old tricks.
With mixed in the code, the warnings are gone,
This bunny’s delighted—let’s all hop along!
🐇✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

@Strift Strift added the enhancement New feature or request label May 14, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/Contracts/Data.php (1)

32-39: Consider implementing null coalescing operator

The method implementation could be simplified using PHP's null coalescing operator.

     public function offsetGet($offset): mixed
     {
-        if (isset($this->data[$offset])) {
-            return $this->data[$offset];
-        }
-
-        return null;
+        return $this->data[$offset] ?? null;
     }

This is a minor readability improvement that doesn't change functionality.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 520036c and bd600a8.

📒 Files selected for processing (1)
  • src/Contracts/Data.php (1 hunks)

Comment on lines 31 to +32
#[\ReturnTypeWillChange]
public function offsetGet($offset)
public function offsetGet($offset): mixed
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Remove redundant attribute with mixed return type

The change to add : mixed return type is correct and aligns with PHP 8 practices. However, the #[\ReturnTypeWillChange] attribute on line 31 is now redundant and should be removed since you've explicitly declared the return type.

-    #[\ReturnTypeWillChange]
     public function offsetGet($offset): mixed

This change appropriately resolves the deprecation notice while taking advantage of PHP 8's type system. As noted in the PR discussion, this does make PHP 8.0+ a requirement for this library.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
#[\ReturnTypeWillChange]
public function offsetGet($offset)
public function offsetGet($offset): mixed
public function offsetGet($offset): mixed

@Strift
Copy link
Collaborator

Strift commented May 14, 2025

We can pick this up after merging #735 which drops PHP versions < 8.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add mixed type declaration to deprecated ArrayAccess::offsetGet()
3 participants