jk-oster/laravel-collection-trend

Generate trends from collections. Easily create charts or reports.

v0.1.1 2024-10-22 01:54 UTC

Requires

• php: ^8
• illuminate/contracts: ^10.0||^11.0
• illuminate/support: ^10||^11
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^9.0.0||^8.22.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3
• spatie/laravel-ray: ^1.35

MIT

• Jakob Osterberger

• collections
• data
• charts
• laravel
• reports
• trends
• Jakob Osterberger
• laravel-collection-trend

README

Generate trends from collections. Easily create charts or reports.

For detailed examples checkout the docs page.

Why?

Most applications require charts or reports to be generated. Doing this over again, and again can be a painful process. That's why I've created a fluent Laravel package to solve this problem (inspired by laravel-trend).

Installation & Setup

You can install this package with composer using the following command:

composer require jk-oster/laravel-collection-trend

Usage

To generate a trend for your model, import the JkOster\CollectionTrend\CollectionTrend class and pass along a collectable.

Example:

// Totals per month
$trend = CollectionTrend::make($collectable)
    ->between(
        start: now()->startOfYear(),
        end: now()->endOfYear(),
    )
    ->perMonth()
    ->count();

// Average user weight where name starts with a over a span of 11 years, results are grouped per year
$trend = CollectionTrend::make($collectable)
    ->between(
        start: now()->startOfYear()->subYears(10),
        end: now()->endOfYear(),
    )
    ->perYear()
    ->average('weight');

Starting a trend

You can either start a trend using ::make() or ::collect().

CollectionTrend::make($collectable)
    ->between(...)
    ->perDay()
    ->count();

CollectionTrend::collect($collectable)
    ->between(...)
    ->perDay()
    ->count();

Interval

You can use the following aggregates intervals:

perMinute()
perHour()
perDay()
perMonth()
perYear()

Aggregates

You can use the following aggregates:

sum('column')
average('column')
median('column')
max('column')
min('column')
count('*')

Date Column

By default, laravel-collection-trend assumes that the model on which the operation is being performed has a created_at date column. If your model uses a different column name for the date or you want to use a different one, you should specify it using the dateColumn(string|Closure $column) method.

Example:

CollectionTrend::make($collectable)
    ->dateColumn('custom_date_column')
    ->between(...)
    ->perDay()
    ->count();

// Or using a closure

CollectionTrend::collect($collectable)
    ->dateColumn(fn ($item) => $item['custom_date_column'])
    ->between(...)
    ->perDay()
    ->count();

This allows you to work with models that have custom date column names or when you want to analyze data based on a different date column.

Value Column

By default laravel-collection-trend you have to specify the column that contains the values you want to aggregate in the aggregate method. Like the date column you can specify it using a string|Closure which you pass in the aggregate method.

Example:

CollectionTrend::make($collectable)
    ->between(...)
    ->perDay()
    ->sum('value_column');

// Or using a closure

CollectionTrend::collect($collectable)
    ->between(...)
    ->perDay()
    ->sum(fn ($item) => $item['value_column']);

Empty Data Fillers

By default laravel-collection-trend fills up missing data with the value 0. You can change this behavior by passing a int as second argument to the aggregate method.

Example:

CollectionTrend::make($collectable)
    ->between(...)
    ->perDay()
    ->sum('value_column', -1);

Compatibility with Flowframe/Laravel-Trend

The interface of the package to the biggest part compatible with the Laravel-Trend package. You only need to exchange the Trend::model($model) calls with CollectionTrend::make($collectable).

License

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

Credits

Thanks to the creators of flowframe/laravel-trend for inspiration.

• Jakob Osterberger
• All Contributors