README

Build your time series with ease

About

Laravel Time Series provides an API to projects data from your Eloquent models, and convert them to time series.

Documentation

The full documentation can be found here.

Usage

Installation

composer require timothepearce/laravel-time-series

Migrate the tables

php artisan migrate

Create a Projection

php artisan make:projection MyProjection

Make a model projectable

When you want to make your model projectable, you must add it the Projectable trait and define the $projections class attribute:

use App\Models\Projections\MyProjection;
use TimothePearce\TimeSeries\Projectable;

class MyProjectableModel extends Model
{
    use Projectable;

    protected array $projections = [
        MyProjection::class,
    ];
}

If you want to use a different date field from your Model instead of created_at then do the following :

1. Make sure the field is casted to Carbon

use App\Models\Projections\MyProjection;
use TimothePearce\TimeSeries\Projectable;

class MyProjectableModel extends Model
{
    use Projectable;

    protected $casts = [
        'other_date_time' => 'datetime:Y-m-d H:00',
    ];

    protected array $projections = [
        MyProjection::class,
    ];
}

1. Add the dateColumn field in your Projection

namespace App\Models\Projections;

use Illuminate\Database\Eloquent\Model;
use TimothePearce\TimeSeries\Contracts\ProjectionContract;
use TimothePearce\TimeSeries\Models\Projection;

class MyProjection extends Projection implements ProjectionContract
{
    /**
     * The projected periods.
     */
    public array $periods = [];

    public string $dateColumn = 'other_date_time';
....

Implement a Projection

When you're implementing a projection, follow theses three steps:

• Define your projection periods
• Add a default content
• Bind your projection to the projectable models

Query a Projection

A Projection is an Eloquent model and is queried the same way, but keep in mind that the projections are all stored in a single table. That means you'll have to use scope methods to get the correct projections regarding the period you defined earlier:

MyProjection::period('1 day')
    ->between(
        today()->subDay(), // start date
        today(), // end date
    )
    ->get();

Query a time series

To get a time series from a projection model, use the toTimeSeries method:

MyProjection::period('1 day')
    ->toTimeSeries(
        today()->subDay(),
        today(),
    );

Note that this method fill the missing projections between the given dates with the default content you defined earlier.

Credits

• Timothé Pearce
• All contributors

License

The MIT License (MIT). Please see License File for more information.