Working with dates | laravel-data | Spatie SPATIE Laravel Data =============== spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-data](https://spatie.be/docs/laravel-data/v2) Advanced-usage Working with dates Version v4 v3 v2 v1 Other versions for crawler [v4](https://spatie.be/docs/laravel-data/v4) [v3](https://spatie.be/docs/laravel-data/v3) [v2](https://spatie.be/docs/laravel-data/v2) [v1](https://spatie.be/docs/laravel-data/v1) - [ Introduction ](https://spatie.be/docs/laravel-data/v2/introduction) - [ Support us ](https://spatie.be/docs/laravel-data/v2/support-us) - [ Requirements ](https://spatie.be/docs/laravel-data/v2/requirements) - [ Installation & setup ](https://spatie.be/docs/laravel-data/v2/installation-setup) - [ Questions and issues ](https://spatie.be/docs/laravel-data/v2/questions-issues) - [ Changelog ](https://spatie.be/docs/laravel-data/v2/changelog) - [ About us ](https://spatie.be/docs/laravel-data/v2/about-us) Getting started --------------- - [ Quickstart ](https://spatie.be/docs/laravel-data/v2/getting-started/quickstart) As a DTO -------- - [ Creating a data object ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/creating-a-data-object) - [ Optional properties ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/optional-properties) - [ Nesting ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/nesting) - [ Collections ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/collections) - [ Casts ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/casts) - [ From a request ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/request-to-data-object) As a resource ------------- - [ From data to resource ](https://spatie.be/docs/laravel-data/v2/as-a-resource/from-data-to-resource) - [ Including and excluding properties ](https://spatie.be/docs/laravel-data/v2/as-a-resource/lazy-properties) - [ Wrapping ](https://spatie.be/docs/laravel-data/v2/as-a-resource/wrapping) - [ Transforming data ](https://spatie.be/docs/laravel-data/v2/as-a-resource/transformers) Advanced usage -------------- - [ Eloquent casting ](https://spatie.be/docs/laravel-data/v2/advanced-usage/eloquent-casting) - [ Transforming to TypeScript ](https://spatie.be/docs/laravel-data/v2/advanced-usage/typescript) - [ Working with dates ](https://spatie.be/docs/laravel-data/v2/advanced-usage/working-with-dates) - [ Normalizers ](https://spatie.be/docs/laravel-data/v2/advanced-usage/normalizers) - [ Pipeline ](https://spatie.be/docs/laravel-data/v2/advanced-usage/pipeline) - [ Use with Inertia ](https://spatie.be/docs/laravel-data/v2/advanced-usage/use-with-inertia) - [ Use with Livewire ](https://spatie.be/docs/laravel-data/v2/advanced-usage/use-with-livewire) - [ Creating a cast ](https://spatie.be/docs/laravel-data/v2/advanced-usage/creating-a-cast) - [ Creating a transformer ](https://spatie.be/docs/laravel-data/v2/advanced-usage/creating-a-transformer) - [ Creating a rule inferrer ](https://spatie.be/docs/laravel-data/v2/advanced-usage/creating-a-rule-inferrer) - [ Internal structures ](https://spatie.be/docs/laravel-data/v2/advanced-usage/internal-structures) - [ Validation attributes ](https://spatie.be/docs/laravel-data/v2/advanced-usage/validation-attributes) You are viewing the documentation for **an older version** of this package. You can check the version you are using with the following command: ` composer show spatie/laravel-data ` Working with dates ================== ### On this page 1. [ Multiple date formats ](#content-multiple-date-formats) 2. [ Casting dates in a different time zone ](#content-casting-dates-in-a-different-time-zone) 3. [ Changing time zones ](#content-changing-time-zones) Dates can be hard, there are tons of formats to cast them from or transform them to. Within the `data.php` config file a default date format can be set: ``` 'date_format' => DATE_ATOM, ``` Now when using the `DateTimeInterfaceCast` or `DateTimeInterfaceTransformer` the format defined will be used ``` #[WithCast(DateTimeInterfaceCast::class)] #[WithTransformer(DateTimeInterfaceTransformer::class)] public DateTime $date ``` It is also possible to manually set the format; ``` #[WithCast(DateTimeInterfaceCast::class, format: DATE_ATOM)] #[WithTransformer(DateTimeInterfaceTransformer::class, format: DATE_ATOM)] public DateTime $date ``` When casting the data object will use the type of the property to cast a date string into, so if you want to use `Carbon`, that's perfectly possible: ``` #[WithCast(DateTimeInterfaceCast::class)] public Carbon $date ``` You can even manually specify the type the date string should be cast to: ``` #[WithCast(DateTimeInterfaceCast::class, type: CarbonImmutable::class)] public $date ``` Multiple date formats ----------------------------------------------------------------------------------------------------------------------- Sometimes your application might use different date formats, for example, you receive dates from an IOS and React application. These use different underlying date formats. In such case you can add an array to the `date_format` key within the `data.php` config file: ``` 'date_format' => [DATE_ATOM, 'Y-m-d'], ``` Now when casting a date, a valid format will be searched. When none can be found, an exception is thrown. When a transformers hasn't explicitly stated it's format, the first format within the array is used. Casting dates in a different time zone -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Sometimes a date can be in a different timezone than the timezone you application uses. For example, if your application uses `Europe/Brussels` but your date is in `UTC`: ``` #[WithCast(DateTimeInterfaceCast::class, timeZone: 'UTC')] public DateTime $date ``` The date will be created with the `UTC` timezone but will be the same as in the `Europe/Brussels` timezone. Changing time zones ----------------------------------------------------------------------------------------------------------------- When casting a date you may want to set an alternative timezone this can be achieved as such: ``` #[WithCast(DateTimeInterfaceCast::class, setTimeZone: 'Europe/Brussels')] public DateTime $date ``` In this case the time will be transformed, if our original time was in `UTC` then one or two hours (depending on summer time) will be added. You can also change the timezone of a property which is getting transformed: ``` #[WithTransformer(DateTimeInterfaceTransformer::class, setTimeZone: 'Europe/Brussels')] public DateTime $date ```