https://github.com/atymic/laravel-dateinterval-cast

DateInterval / CarbonInterval custom eloquent cast for Laravel 7.x+
https://github.com/atymic/laravel-dateinterval-cast

cast eloquent laravel laravel-7 laravel-framework laravel-package php php-library

Last synced: about 1 month ago
JSON representation

DateInterval / CarbonInterval custom eloquent cast for Laravel 7.x+

• Host: GitHub
• URL: https://github.com/atymic/laravel-dateinterval-cast
• Owner: atymic
• Created: 2020-02-26T06:05:47.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-05T13:19:42.000Z (over 3 years ago)
• Last Synced: 2024-09-27T22:20:59.384Z (about 2 months ago)
• Topics: cast, eloquent, laravel, laravel-7, laravel-framework, laravel-package, php, php-library
• Language: PHP
• Homepage: https://atymic.dev
• Size: 28.3 KB
• Stars: 12
• Watchers: 2
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Laravel DateInterval / CarbonInterval Cast

[![Build Status](https://img.shields.io/github/workflow/status/atymic/laravel-dateinterval-cast/PHP?style=flat-square)](https://github.com/atymic/laravel-dateinterval-cast/actions) 

[![StyleCI](https://styleci.io/repos/243181977/shield)](https://styleci.io/repos/243181977) 

[![Latest Version on Packagist](https://img.shields.io/packagist/v/atymic/laravel-dateinterval-cast.svg?style=flat-square)](https://packagist.org/packages/atymic/laravel-dateinterval-cast) 

[![Total Downloads](https://img.shields.io/packagist/dt/atymic/laravel-dateinterval-cast.svg?style=flat-square)](https://packagist.org/packages/atymic/laravel-dateinterval-cast) 

Laravel has built-in casting for `date` & `datetime` types, but if you want to use ISO 8061 durations with the native

`DateInterval` class, or Carbon's `CarbonInterval` you're out of luck.

This package provides two custom casts (for `DateInterval` and `CarbonInterval` respectively) using Laravel 7.x/8.x's custom

casts feature.

## Installation

```bash

composer require atymic/laravel-dateinterval-cast

```

## Using this package

In your model's `$casts`, assign the property you wish to enable casting on to either of the casts provided by the package.

You should use a `varchar`/`string` field in your database table.

```php

class TestModel extends Model

{

    /**

     * The attributes that should be cast to native types.

     *

     * @var array

     */

    protected $casts = [

        'is_xyz' => 'boolean',

        'date_interval' => DateIntervalCast::class,

        'carbon_interval' => CarbonIntervalCast::class,

    ];

}

```

The property on the model will then be cast to an interval object, and saved to the database as a ISO 8061 duration string.

If you try to assign an invalid duration (or the database table contains one, and you use a getter) an exception is thrown.

```php

$model = new TestModel();

$model->carbon_interval = now()->subHours(3)->diffAsCarbonInterval();

$model->save(); // Saved as `P3H`

$model->fresh();

$model->carbon_interval; // Instance of `CarbonInterval`

$model->carbon_interval->forHumans(); // prints '3 hours ago'

try {

    $model->carbon_interval = 'not_a_iso_period'; 

} catch (\Atymic\DateIntervalCast\Exception\InvalidIsoDuration $e) {

    // Exception thrown if you try to assign an invalid duration

}

```

## Contributing

Contributions welcome :) 

Please create a PR and i'll review/merge it. 

## Licence

MIT