refactor: PHPDocs in env()

[ddevsr]

Description
default not sync with return

env('myconfig.isLogApi', config(MyConfig::class)->isLogApi); // bool
env('myconfig.httpVersion', config(MyConfig::class)->httpVersion); // float
env('myconfig.timeout', config(MyConfig::class)->timeout); // int

Checklist:

• Securely signed commits
• Component(s) with PHPDoc blocks, only if necessary or adds value
• Unit testing, with >80% coverage
• User guide updated
• Conforms to style guide

[neznaika0]

We get rid of "mixed" wherever possible. array<int|string, mixed> is better.

[paulbalandan]

hey, can this be better suited if we use generics instead?

[ddevsr]

Do you mean like this? i think better

--- a/system/Common.php
+++ b/system/Common.php
@@ -371,9 +371,11 @@ if (! function_exists('env')) {
      * retrieving values set from the .env file for
      * use in config files.
      *
-     * @param array<int|string, mixed>|bool|float|int|string|null $default
+     * @template T
      *
-     * @return array<int|string, mixed>|bool|float|int|string|null        
+     * @param T|null $default
+     *
+     * @return T|null
      */
     function env(string $key, $default = null)
     {

[paulbalandan]

I think you can drop the null part in the phpdocs: see https://phpstan.org/r/b764e608-6ea7-4edf-aa2d-5821cc80057b. But please try again with your examples.

[ddevsr]

When i set default from my config property is passed. The problem is $default not set, developer needed recasting like (string) env('myconfig.title').

EDIT : Now all passed using @return ($default is null ? array<int|string, mixed>|bool|float|int|string|null : T)

[ddevsr]

@paulbalandan I'm not familiar with psalm

[paulbalandan]

Sorry, please disregard the generics idea. I tried tinkering it on the phpstan playground and I got no luck.

[ddevsr]

Local and runner already passed

https://phpstan.org/r/a5f5dca8-279a-4e60-ae66-6468e77afb14

[paulbalandan]

The thing is $default does not determine the return of the function if it is null as it can be a valid return value itself if the key is not found.