Download the PHP package jlorente/laravel-eloquent-splitted-dates-trait without Composer
On this page you can find all versions of the php package jlorente/laravel-eloquent-splitted-dates-trait. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jlorente/laravel-eloquent-splitted-dates-trait
More information about jlorente/laravel-eloquent-splitted-dates-trait
Files in jlorente/laravel-eloquent-splitted-dates-trait
Package laravel-eloquent-splitted-dates-trait
Short Description A Laravel Trait for Eloquent Models to handle date fields that are stored both in the date field itself and in separate field components such as year, month, day, time, etc...
License BSD-3-Clause
Informations about the package laravel-eloquent-splitted-dates-trait
Laravel Eloquent Model Splitted Dates Trait
A Laravel Trait for Eloquent Models to handle date fields that are stored both in the date field itself and in separate field components such as year, month, day, hour, etc...
Installation
The preferred way to install this extension is through composer.
With Composer installed, you can then install the extension using the following commands:
or add
to the section of your composer.json
file.
Usage
Basic Configuration
To enable and configure splitted dates fields in an Eloquent Model use the Jlorente\Laravel\Eloquent\Concerns\SplittedDates\HasSplittedDates Trait on the model and define the splittedDates array with the date fields you want to store splitted.
In the example, the "begin_at" date will be stored splitted in the fields "begin_at_year", "begin_at_month" and "begin_at_day". Everytime the "begin_at" field is set, the other fields will be set also and vice versa.
If one of the splitted components is null, the main attribute "begin_at" correspondent component will be set to to 1 in case of month and day properties, 0 in case of time properties or the current year in case of year property.
All the attributes defined in the splittedDates array will be treated as defined in the date mutator property so you can set its value to a UNIX timestamp, date string (Y-m-d), date-time string, or a DateTime / Carbon instance.
Remember that the database table must have the correspondent columns "_year", "_month" and "_day" to store the splitted date value.
Advanced Configuration
The default configuration for splitted dates is to map the date value to a year, month and day field, but you can map the value to whatever carbon unit you want (year, month, day, hour, minute, second, milli, millisecond, micro, microsecond).
To configure the splitted date with other units than the default ones define which ones do you want to store on splittedDates property definition.
Doing so, the properties "begin_at_hour" and "begin_at_minute" will be set everytime the "begin_at" field is set and vice versa.
Further considerations
The trait does not validate dates when setting the splitted fields, so it is possible that date overflows ocurr if you set an invalid value for a date.
License
Copyright © 2019 José Lorente Martín [email protected].
Licensed under the BSD 3-Clause License. See LICENSE.txt for details.