Fix php81 deprecated warnings

[pbojan]

🔀 Pull Request

What does this PR do?

Fix deprecated warnings for PHP 8.1:

Deprecated: Return type of Flow\JSONPath\JSONPath::key() should either be compatible with Iterator::key(): mixed, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice
Exception:
ErrorException: Deprecated: Return type of Flow\JSONPath\JSONPath::key() should either be compatible with Iterator::key(): mixed, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice in /www/foe/libs/external/softcreatr/jsonpath/src/JSONPath.php:271

Test Plan

No automated test plan only manual testing done.

Related PRs and Issues

No related PRs or Issues

[SoftCreatR]

Thank you. However, this will be a breaking change, since the mixed keyword doesn't exist in older PHP versions.

So to get rid of these notices, way more work is required (e.g. publish a new tag >= 0.8), PHP unit updates, etc.

[pbojan]

That is very true. Any plans from your side to migrate to at least PHP 8.0? I could potentially help out but I don't know how much work that would be as I am not aware of all the side-effects that could create.

[SoftCreatR]

PHP 8.0+ is officially supported and covered by our automatic tests (see https://github.com/SoftCreatR/JSONPath/blob/main/.github/workflows/Test.yml#L24).

However, if there's any need, I'll release a new version for sure.

[andrew-demb]

How about just adding #[\ReturnTypeWillChange] attribute?

[SoftCreatR]

That's the current plan.

[SoftCreatR]

That's also a breaking change, because it doesn't work with older PHP versions.

[pbojan]

Should I update the PR to remove the mixed and replace it with the Attribute then?

[SoftCreatR]

No. A new version (for PHP 8.0+) is required here.

[pbojan]

Actually I think this works because for previous PHP versions attributes are regarded as comments:

PHP versions prior to 8.0 parses the attribute syntax as a code comment, and does not cause any syntax errors. Adding #[\ReturnTypeWillChange] attribute to a class method does not cause any issues, but omits the deprecation notice in PHP 8.1.

https://php.watch/versions/8.1/ReturnTypeWillChange

[SoftCreatR]

Yeah, my bad. I forgot to put that on a separate line, so all tests failed locally :)

But I'm already working on updates.

[SoftCreatR]

Resolved via 37f949d

[pbojan]

@SoftCreatR thank you for the quick fix!

[SoftCreatR]

Please let me know, if the provided solution works for you.

[gigimaor]

Hello
Continuing to the above, I have the same issue, but no solution is present in the code.

Error message Deprecated function: Return type of Flow\JSONPath\JSONPath::offsetGet($offset) should either be compatible with ArrayAccess::offsetGet(mixed $offset): mixed, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice in include() (line 29 of /builds/web-team/ua-arop/vendor/softcreatr/jsonpath/src/JSONPath.php).

This new attribute that supports php:^81 is required #[\ReturnTypeWillChange] or fixing the compatibility issue described in the error.

Please advise.

[SoftCreatR]

Are you using the latest version 0.8.2?

[gigimaor]

I update the version, and the solution presents itself

[SoftCreatR]

Means?

[gigimaor]

Updating to version 0.8.2 has fixed the issue. Thanks