Skip to content

Conversation

@sylbru
Copy link

@sylbru sylbru commented Mar 26, 2025

Hi! This is just a small PR to update a few typehints that are causing deprecation warnings starting with PHP 8.4 (released in November 2024). Sorry I’m not sure how to prefix the commit following the recommended notation.

Description

In order to fix a deprecation introduced in PHP 8.4, this makes explicit the "implicit nullable" type hints in function arguments.

For example:

public function something(array $parameters = null)

This generates a deprecation warning.

The solution

The $parameters argument is supposed to be an array, but its default value is null, so its actual type is "array or null". We need to make it explicit by prefixing the type with a question mark (a null|array union type would work too):

public function something(array $parameters = null)

See https://php.watch/versions/8.4/implicitly-marking-parameter-type-nullable-deprecated

Summary by Sourcery

Update type hints to explicitly mark nullable parameters to resolve PHP 8.4 deprecation warnings

Bug Fixes:

  • Resolve deprecation warnings for implicitly nullable type hints introduced in PHP 8.4

Enhancements:

  • Modify function signatures to use explicit nullable type hints by adding '?' prefix to type declarations

@sourcery-ai
Copy link

sourcery-ai bot commented Mar 26, 2025

Reviewer's Guide by Sourcery

This pull request updates type hints in several files to explicitly allow null values, addressing a deprecation warning introduced in PHP 8.4. The change involves prefixing type hints with a question mark ? to indicate nullable types.

Updated class diagram for DiffInfo

classDiagram
  class DiffInfo {
    +diffProgram
    +parameters
    +fileExtensions
    +__construct(string diffProgram, array fileExtensions, ?string parameters = null)
  }
Loading

File-Level Changes

Change Details Files
Updated type hints to explicitly allow null values for function arguments, resolving a deprecation warning in PHP 8.4.
  • Changed Reporter $reporter = null to ?Reporter $reporter = null in multiple functions.
  • Changed string $parameters = null to ?string $parameters = null in DiffInfo.php.
src/CombinationApprovals.php
src/Approvals.php
src/Reporters/DiffInfo.php

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant