Update handling of dates for Laravel 10

README.md

@@ -256,8 +256,6 @@ use Jenssegers\Mongodb\Eloquent\SoftDeletes;
 class User extends Model
 {
  use SoftDeletes;
-
- protected $dates = ['deleted_at'];
 }
 ```
 
@@ -279,7 +277,7 @@ use Jenssegers\Mongodb\Eloquent\Model;
 
 class User extends Model
 {
- protected $dates = ['birthday'];
+ protected $casts = ['birthday' => 'datetime'];
 }
 ```
 

src/Eloquent/Model.php

@@ -2,18 +2,23 @@
 
 namespace Jenssegers\Mongodb\Eloquent;
 
+use function array_key_exists;
 use DateTimeInterface;
+use function explode;
 use Illuminate\Contracts\Queue\QueueableCollection;
 use Illuminate\Contracts\Queue\QueueableEntity;
+use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Database\Eloquent\Model as BaseModel;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Date;
 use Illuminate\Support\Str;
+use function in_array;
 use Jenssegers\Mongodb\Query\Builder as QueryBuilder;
 use MongoDB\BSON\Binary;
 use MongoDB\BSON\ObjectID;
 use MongoDB\BSON\UTCDateTime;
+use function uniqid;
 
 abstract class Model extends BaseModel
 {
@@ -94,7 +99,7 @@ public function fromDateTime($value)
  $value = parent::asDateTime($value);
  }
 
- return new UTCDateTime($value->format('Uv'));
+ return new UTCDateTime($value);
  }
 
  /**
@@ -191,13 +196,14 @@ public function setAttribute($key, $value)
  $value = $builder->convertKey($value);
  } // Support keys in dot notation.
  elseif (Str::contains($key, '.')) {
- if (in_array($key, $this->getDates()) && $value) {
-  $value = $this->fromDateTime($value);
- }
+ // Store to a temporary key, then move data to the actual key
+ $uniqueKey = uniqid($key);
+ parent::setAttribute($uniqueKey, $value);
 
- Arr::set($this->attributes, $key, $value);
+ Arr::set($this->attributes, $key, $this->attributes[$uniqueKey] ?? null);
+ unset($this->attributes[$uniqueKey]);
 
- return;
+ return $this;
  }
 
  return parent::setAttribute($key, $value);
@@ -222,13 +228,6 @@ public function attributesToArray()
  }
  }
 
- // Convert dot-notation dates.
- foreach ($this->getDates() as $key) {
- if (Str::contains($key, '.') && Arr::has($attributes, $key)) {
- Arr::set($attributes, $key, (string) $this->asDateTime(Arr::get($attributes, $key)));
- }
- }
-
  return $attributes;
  }
 
@@ -515,4 +514,62 @@ public function __call($method, $parameters)
 
  return parent::__call($method, $parameters);
  }
+
+ /**
+ * Add the casted attributes to the attributes array.
+ *
+ * @param array $attributes
+ * @param array $mutatedAttributes
+ * @return array
+ */
+ protected function addCastAttributesToArray(array $attributes, array $mutatedAttributes)
+ {
+ foreach ($this->getCasts() as $key => $castType) {
+ if (! Arr::has($attributes, $key) || Arr::has($mutatedAttributes, $key)) {
+ continue;
+ }
+
+ $originalValue = Arr::get($attributes, $key);
+
+ // Here we will cast the attribute. Then, if the cast is a date or datetime cast
+ // then we will serialize the date for the array. This will convert the dates
+ // to strings based on the date format specified for these Eloquent models.
+ $castValue = $this->castAttribute(
+ $key, $originalValue
+ );
+
+ // If the attribute cast was a date or a datetime, we will serialize the date as
+ // a string. This allows the developers to customize how dates are serialized
+ // into an array without affecting how they are persisted into the storage.
+ if ($castValue !== null && in_array($castType, ['date', 'datetime', 'immutable_date', 'immutable_datetime'])) {
+ $castValue = $this->serializeDate($castValue);
+ }
+
+ if ($castValue !== null && ($this->isCustomDateTimeCast($castType) ||
+ $this->isImmutableCustomDateTimeCast($castType))) {
+ $castValue = $castValue->format(explode(':', $castType, 2)[1]);
+ }
+
+ if ($castValue instanceof DateTimeInterface &&
+ $this->isClassCastable($key)) {
+ $castValue = $this->serializeDate($castValue);
+ }
+
+ if ($castValue !== null && $this->isClassSerializable($key)) {
+ $castValue = $this->serializeClassCastableAttribute($key, $castValue);
+ }
+
+ if ($this->isEnumCastable($key) && (! $castValue instanceof Arrayable)) {
+ $castValue = $castValue !== null ? $this->getStorableEnumValue($attributes[$key]) : null;
+ }
+
+ if ($castValue instanceof Arrayable) {
+ $castValue = $castValue->toArray();
+ }
+
+ Arr::set($attributes, $key, $castValue);
+ }
+
+ return $attributes;
+ }
 }

tests/ModelTest.php

@@ -577,8 +577,7 @@ public function testDates(): void
  $this->assertInstanceOf(Carbon::class, $user->getAttribute('entry.date'));
 
  $data = $user->toArray();
- $this->assertNotInstanceOf(UTCDateTime::class, $data['entry']['date']);
- $this->assertEquals((string) $user->getAttribute('entry.date')->format('Y-m-d H:i:s'), $data['entry']['date']);
+ $this->assertIsString($data['entry']['date']);
  }
 
  public function testCarbonDateMockingWorks()

tests/models/Soft.php

@@ -17,5 +17,5 @@ class Soft extends Eloquent
  protected $connection = 'mongodb';
  protected $collection = 'soft';
  protected static $unguarded = true;
- protected $dates = ['deleted_at'];
+ protected $casts = ['deleted_at' => 'datetime'];
 }

tests/models/User.php

@@ -33,7 +33,10 @@ class User extends Eloquent implements AuthenticatableContract, CanResetPassword
  use Notifiable;
 
  protected $connection = 'mongodb';
- protected $dates = ['birthday', 'entry.date'];
+ protected $casts = [
+ 'birthday' => 'datetime',
+ 'entry.date' => 'datetime',
+ ];
  protected static $unguarded = true;
 
  public function books()