Docs

Author: pascalbaljet

README.md

@@ -159,6 +159,38 @@ Instead of setting a default value, you can also pass in a target, like an Eloqu
 
 In the example above, where `$video` is an Eloquent model, the default value will be `$video->description`.
 
+#### Date Casting
+
+If you use Eloquent's [Date Casting](https://laravel.com/docs/8.x/eloquent-mutators#date-casting) feature, you can use the date attributes in your forms by setting the `use_eloquent_date_casting` configuration key to `true`. For compatibility reasons, this is disabled by default.
+
+```php
+return [
+    'use_eloquent_date_casting' => true,
+];
+```
+
+You can either use the `dates` property or the `casts` property in your Eloquent model to specify date attributes:
+
+```php
+class ActivityModel extends Model
+{
+    public $dates = ['finished_at'];
+
+    public $casts = [
+        'started_at'   => 'date',
+        'failed_at'    => 'datetime',
+        'completed_at' => 'date:d-m-Y',
+        'skipped_at'   => 'datetime:Y-m-d H:i',
+    ];
+}
+```
+
+```blade
+<x-form-input name="completed_at" :bind="$activity" />
+```
+
+In the example above, the default value will be formatted like `31-10-2021`.
+
 #### Binding a target to multiple elements
 
 You can also bind a target by using the `@bind` directive. This will bind the target to all elements until the `@endbind` directive.

config/config.php

@@ -8,6 +8,8 @@
     /** tailwind | tailwind-2 | bootstrap-4 | bootstrap-5 */
     'framework' => 'tailwind',
 
+    'use_eloquent_date_casting' => false,
+
     'components' => [
         'form' => [
             'view'  => 'form-components::{framework}.form',

src/Components/HandlesBoundValues.php

@@ -7,6 +7,7 @@
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 use Illuminate\Support\Carbon;
+use Illuminate\Support\Str;
 use ProtoneMedia\LaravelFormComponents\FormDataBinder;
 
 trait HandlesBoundValues
@@ -77,6 +78,10 @@ private function getBoundValue($bind, string $name)
      */
     private function formatDateTime(Model $model, string $key, DateTimeInterface $date)
     {
+        if (!config('form-components.use_eloquent_date_casting')) {
+            return $date;
+        }
+
         $cast = $model->getCasts()[$key] ?? null;
 
         if (!$cast || $cast === 'date' || $cast === 'datetime') {
@@ -98,7 +103,12 @@ private function formatDateTime(Model $model, string $key, DateTimeInterface $da
      */
     protected function isCustomDateTimeCast($cast)
     {
-        return strncmp($cast, 'date:', 5) === 0 || strncmp($cast, 'datetime:', 9) === 0;
+        return Str::startsWith($cast, [
+            'date:',
+            'datetime:',
+            'immutable_date:',
+            'immutable_datetime:',
+        ]);
     }
 
     /**

tests/Feature/ActivityModel.php

@@ -11,6 +11,8 @@ class ActivityModel extends Model
         'date_c' => 'datetime',
         'date_d' => 'date:Y',
         'date_e' => 'datetime:Y-m',
+        'date_f' => 'immutable_date:Y',
+        'date_g' => 'immutable_datetime:Y-m',
     ];
 
     public $dates = ['date_a'];

tests/Feature/DateTimeCastTest.php

@@ -11,6 +11,8 @@ class DateTimeCastTest extends TestCase
     /** @test */
     public function it_supports_date_casts_and_custom_casts()
     {
+        config(['form-components.use_eloquent_date_casting' => true]);
+
         $this->registerTestRoute('date-time-casts');
 
         Carbon::setTestNow(Carbon::parse('2021-11-01 12:00:00'));
@@ -23,13 +25,17 @@ public function it_supports_date_casts_and_custom_casts()
             'date_c' => now(),
             'date_d' => now(),
             'date_e' => now(),
+            'date_f' => now(),
+            'date_g' => now(),
         ]));
 
         $this->visit('/date-time-casts')
             ->seeElement('input[name="date_a"][value="2021-11-01T12:00:00.000000Z"]')
             ->seeElement('input[name="date_b"][value="2021-11-01T00:00:00.000000Z"]')
             ->seeElement('input[name="date_c"][value="2021-11-01T12:00:00.000000Z"]')
             ->seeElement('input[name="date_d"][value="2021"]')
-            ->seeElement('input[name="date_e"][value="2021-11"]');
+            ->seeElement('input[name="date_e"][value="2021-11"]')
+            ->seeElement('input[name="date_f"][value="2021"]')
+            ->seeElement('input[name="date_g"][value="2021-11"]');
     }
 }

tests/Feature/views/date-time-casts.blade.php

@@ -5,6 +5,8 @@
         <x-form-input name="date_c" />
         <x-form-input name="date_d" />
         <x-form-input name="date_e" />
+        <x-form-input name="date_f" />
+        <x-form-input name="date_g" />
 
         <x-form-submit />
     @endbind