Fixes: getting immutable_datetime property fails if Date::use(CarbonImmutable::class) is set

[saineshmamgain]

This PR fixes the issue #3341 .

Basically when Date::use(CarbonImmutable::class); is added. The method asDateTime in DocumentModel trait throws an exception. I've changed the return type of asDateTime method from Carbon to DateTimeInterface.

Checklist

• Add tests and ensure they pass

[GromNaN]

I added a minor comment, but the overall seems good to me. Thanks!

[GromNaN]

These annotations are interesting, I think we should document this practice (something I will ask the doc team).

[saineshmamgain]

credit goes to @Treggats. I followed his HiddenAnimal model.

[Treggats]

Happy to help :)

[Treggats]

@GromNaN the thing with Laravel Models is that by default they have the type Model. Which makes sense, as the model extends that class, but then the IDE doesn't know about any of the methods, relations, properties, etc.

These docblocks provide the IDE with the context it should have. Note; the @method docblock can not be used if the method already exists in the class.

Personally I also use @property for the columns of the database table and the relation once fetched.
The @property-read docblock is used for the Builder return type of a relation.

A little gotcha is that sometimes you need a additional docblock on the variable. Like this.

use Tests\Models\Anniversary;

/** @var Anniversary $anniversary */
$anniversary = Anniversary::query()->where('name', 'John')->first();

It then knows about the properties, relations, etc.

Hope this helps.

[GromNaN]

Thanks, I'm tracking this to work on it later PHPORM-316

[GromNaN]

@saineshmamgain can you look at the test failure:

1) MongoDB\Laravel\Tests\Eloquent\DateTimeImmutableTest::testCanReturnCarbonImmutableObject
* Test code or tested code did not remove its own error handlers

* Test code or tested code did not remove its own exception handlers

/home/runner/work/laravel-mongodb/laravel-mongodb/tests/DateTimeImmutableTest.php:28

[saineshmamgain]

@GromNaN actually this error comes when I do the reset Date::useDefault(); in tearDown Method.

[saineshmamgain]

@GromNaN My bad missed call to parent::tearDown() in my method. Updated the PR.

[GromNaN]

Thank you @saineshmamgain