Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Apr 10, 2025
+74 −2
Merged

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

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b751c59
Fixe: error when accessing a immutable_datetime casted property when …
saineshmamgain Apr 9, 2025
0534989
Fix: test
saineshmamgain Apr 9, 2025
dc67388
Fix: test
saineshmamgain Apr 9, 2025
a7e288f
Fix: test
saineshmamgain Apr 9, 2025
4e03bb7
Merge remote-tracking branch 'origin/fix/error-accessing-carbon-immut…
saineshmamgain Apr 9, 2025
8ea6d5c
Merge remote-tracking branch 'origin/fix/error-accessing-carbon-immut…
saineshmamgain Apr 9, 2025
937670d
Merge remote-tracking branch 'origin/fix/error-accessing-carbon-immut…
saineshmamgain Apr 9, 2025
8e534f0
Fix:test
saineshmamgain Apr 9, 2025
5d3fb4d
Reset Date facade to use default in the tearDown method
saineshmamgain Apr 10, 2025
fd47edf
Fix: add call to `parent::tearDown()`
saineshmamgain Apr 10, 2025
bbee5c2
Fix CS
GromNaN Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Eloquent/DocumentModel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public function fromDateTime($value): UTCDateTime
*
* @param mixed $value
*/
protected function asDateTime($value): Carbon
protected function asDateTime($value): DateTimeInterface
{
// Convert UTCDateTime instances to Carbon.
if ($value instanceof UTCDateTime) {
Expand Down
38 changes: 38 additions & 0 deletions tests/DateTimeImmutableTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

declare(strict_types=1);

namespace MongoDB\Laravel\Tests\Eloquent;

use Carbon\CarbonImmutable;
use Illuminate\Support\Facades\Date;
use MongoDB\Laravel\Tests\Models\Anniversary;
use MongoDB\Laravel\Tests\TestCase;

use function assert;

final class DateTimeImmutableTest extends TestCase
{
protected function setUp(): void
{
parent::setUp();

Anniversary::truncate();
}

public function testCanReturnCarbonImmutableObject(): void
{
Date::use(CarbonImmutable::class);

Anniversary::create([
'name' => 'John',
'anniversary' => new CarbonImmutable('2020-01-01 00:00:00'),
]);

$anniversary = Anniversary::sole();
assert($anniversary instanceof Anniversary);
self::assertInstanceOf(CarbonImmutable::class, $anniversary->anniversary);

Date::useDefault();
}
}
30 changes: 30 additions & 0 deletions tests/Models/Anniversary.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?php

declare(strict_types=1);

namespace MongoDB\Laravel\Tests\Models;

use Illuminate\Database\Eloquent\Model;
use MongoDB\Laravel\Eloquent\DocumentModel;
use MongoDB\Laravel\Eloquent\Model as Eloquent;
use MongoDB\Laravel\Query\Builder;

/**
* @property string $name
* @property string $anniversary
* @mixin Eloquent
* @method static Builder create(...$values)
* @method static Builder truncate()
* @method static Eloquent sole(...$parameters)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to help :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

*/
class Anniversary extends Model
{
use DocumentModel;

protected $keyType = 'string';
protected $connection = 'mongodb';
protected $table = 'anniversary';
protected $fillable = ['name', 'anniversary'];

protected $casts = ['anniversary' => 'immutable_datetime'];
}
Loading