Model when use Carbon, auto generate docblock not pass by phpstan.

[bolechen]

this is my User Model diff after run php artisan ide-helper:models -WR

it will remove \Carbon\Carbon in docblock, would lead to result by phpstan: (https://github.com/nunomaduro/larastan)

 ------ -----------------------------------------------------------------------
  Line   User.php
 ------ -----------------------------------------------------------------------
  385    Property App\User::$vip_end (Illuminate\Support\Carbon|null) does not
         accept Carbon\Carbon.
  388    Property App\User::$vip_end (Illuminate\Support\Carbon|null) does not
         accept Carbon\Carbon.
  394    Property App\User::$vip_end (Illuminate\Support\Carbon|null) does not
         accept Carbon\Carbon.
 ------ -----------------------------------------------------------------------

Is there something I'm doing wrong? Please advise, thank you very much!

[bolechen]

my php code sample below

$this->vip_end = $this->vip_end->addDays($vip_days);

[mfn]

I wondered if my PR #859 is responsible but I'm not sure because it looks like when I made the PR, there was already no Carbon\Carbon referenced in the code I changed 🤔

[mfn]

How did you end up with null|\Carbon\Carbon|Illuminate\Support\Carbon in the first place (from your screenshot)?

I've never seen it generated that way from ide-helper?

Even the null|\Illuminate\Support\Carbon is strange, because null is always appended…

Or did you simply have another tool reformatting that before you pasted it? 🤔

[mfn]

null|\Carbon\Carbon|Illuminate\Support\Carbon

What I mean is: ide-helper never generated the union \Carbon\Carbon|Illuminate\Support\Carbon.

• My PR added support for runtime override of the Facade => https://github.com/barryvdh/laravel-ide-helper/pull/859/files#diff-9c76e55ce4ef570404e58c82d642c1e5R299
• before that it was https://github.com/barryvdh/laravel-ide-helper/blame/027e58fd568a46b339452b78557e6f3c56744e48/src/Console/ModelsCommand.php#L287
• before that it was https://github.com/barryvdh/laravel-ide-helper/blame/28f0ac3781c451793ff1c50c8980be1a377936c0/src/Console/ModelsCommand.php#L280

So it never was a union

[bolechen]

Hello @mfn, \Carbon\Carbon is added manual by my self. Because if not add is, will not pass by phpstan. But when I run php artisan ide-helper:models -WR again, is always restore to null|\Illuminate\Support\Carbon.

I don't know if I made myself clear. Sorry for my poor english.

[mfn]

@kylekatarnls phpstsan complains that when a model $model->some_carbon is set with a result of a Carbon method call, that it doesn't accept Carbon\Carbon:

Property App\User::$vip_end (Illuminate\Support\Carbon|null) does not
         accept Carbon\Carbon.

Thing is, it seems a mismatch of (php)doc vs. what really happens?

From Carbon.php:

 * @method        Carbon         addDays(int $value = 1)                                                              Add days (the $value count passed in) to the instance (using date interval).

But the resulting object is Illuminate\Support\Carbon:

$ ./artisan tinker
Psy Shell v0.10.4 (PHP 7.4.9 — cli) by Justin Hileman
>>> $c = new \Illuminate\Support\Carbon;
=> Illuminate\Support\Carbon @1598133330 {#4248
     date: 2020-08-22 21:55:30.588467 UTC (+00:00),
   }
>>> $c->addDays(2);
=> Illuminate\Support\Carbon @1598306130 {#4248
     date: 2020-08-24 21:55:30.588467 UTC (+00:00),
   }

But I see via briannesbitt/Carbon#1914 this was quite deliberate…

So it's either "IDE" or "static analyzers" at the moment?

[kylekatarnls]

Maybe the helper should rather generate \Carbon\CarbonInterface which is the wider requirement while Carbon, CarbonImmutable, Illuminate\Carbon are possible specific implementations.

[mfn]

Interesting idea.

However I'm not seeing myself pursuing this, as if will cause additional confusion when people see the result is \Illuminate\Support\Carbon.

Was my hunch right that?

So it's either "IDE" or "static analyzers" at the moment?

[kylekatarnls]

Actually I would like to PHPDoc the Carbon method with some @return static but when set as a @method annotation, the static keyword is detected as a static-method marker instead of the return type. So I don't know how I could achieve the right typing and properly detected by the IDE too.

[kylekatarnls]

A other possible fix is to copy-paste the \Carbon\Carbon PHPDoc over the \Illuminate\Support\Carbon PHPDoc. This would not be a good thing for the Laravel repository to hard-code this duplicate right in their source, so it should rather be some script to run to override it.

Maybe I can propose a fix for ide-helper:generate to generate the needed extra PHPDoc.

[kylekatarnls]

I also could change Carbon with $this in the PHPDoc which make the typing of sub-classes correct but this would only be correct for Carbon\Carbon, not for Carbon\CarbonImmutable for which the same methods return new instances.

[mfn]

but when set as a @method annotation, the static keyword is detected as a static-method marker instead of the return type. So I don't know how I could achieve the right typing and properly detected by the IDE too.

This may related to https://youtrack.jetbrains.com/issue/WI-54071 …

I also could change Carbon with $this in the PHPDoc

You in fact did, didn't you? => briannesbitt/Carbon@0a41ea7

Because I was about to test this "in code" in an up2date project and I couldn't reproduce it 😅 when I realized vendor/nesbot/carbon/src/Carbon/Carbon.php had $this everywhere already.

but this would only be correct for Carbon\Carbon, not for Carbon\CarbonImmutable

I guess it's fine, because:

• \Illuminate\Support\Carbon does not extend Immutable
• when using your Laravel customization Date::use(CarbonImmutable::class), ide-helper already detects and does generate the CarbonImmutable typehint which works correctly

---

The way I see it, with the release nestbot/carbon 2.39.0 everything is solved and we can close this issue and don't need #1014 ?

[kylekatarnls]

Yes it should be 👌

[mfn]

Solved it is then 😄

[dennis-koster]

I am sorry, but I fail to see how this has been solved. I am still experiencing this exact issue, where the the generated docblocks state Illuminate\Support\Carbon|null and not Carbon\Carbon. I am on nesbot/carbon 2.40.1 and barryvdh/laravel-ide-helper 2.8.1.

[Sergiobop]

This is not solved @kylekatarnls @mfn. You can check larastan/larastan#1067. The packages are not compatible right now