Laravel Trend

To start a trend, you must use either Trend::model() or Trend::query().

• Use Trend::model(Model::class) when you want to perform operations on the entire model.
• Use Trend::query(Builder $query) when you need to apply additional Eloquent filters (like where, has, etc.) before calculating the trend.

// Using model directly
Trend::model(Order::class)
    ->between(...)
    ->perDay()
    ->count();

// Using a specific query with filters
Trend::query(
    Order::query()
        ->hasBeenPaid()
        ->hasBeenShipped()
)
    ->between(...)
    ->perDay()
    ->count();

Install the package using composer to start generating trends for your Eloquent models.

composer require flowframe/laravel-trend

By default, the package assumes your model uses a created_at column. If your model uses a different column for dates, or if you want to aggregate based on a different timestamp, use the dateColumn(string $column) method.

Trend::model(Order::class)
    ->dateColumn('custom_date_column')
    ->between(...)
    ->perDay()
    ->count();

Define how the data should be aggregated within each interval using these methods:

// Available aggregates:
sum('column')
average('column')
max('column')
min('column')
count('*')

Specify the time grouping for your trend using one of the following interval methods:

// Available intervals:
perMinute()
perHour()
perDay()
perMonth()
perYear()

Laravel Trend supports the following database drivers:

- MySQL
- MariaDB
- SQLite
- PostgreSQL

To generate a trend, you must define the time period and the granularity (interval) of the data points.

• between($start, $end): Sets the start and end dates for the trend. Accepts Carbon instances or compatible date strings.
• interval(string $interval): Sets a custom interval.
• Convenience methods for intervals:
  • perMinute()
  • perHour()
  • perDay()
  • perWeek()
  • perMonth()
  • perYear()

$trend->between('2023-01-01', '2023-01-31')
      ->perDay();

By default, the package uses created_at as the date column and date as the alias. You can override these if your table uses different naming conventions.

• dateColumn(string $column): Specifies the column used for the time dimension.
• dateAlias(string $alias): Specifies the alias used in the resulting collection for the date key.

$trend->dateColumn('updated_at')
      ->dateAlias('timestamp');

You can start generating trends using either a specific Eloquent model or an existing Eloquent query builder instance.

• Use Trend::model(ModelName::class) to start a trend analysis from a model's base query.
• Use Trend::query($builder) to start from a custom Eloquent query builder instance (e.g., after applying where or with clauses).

// Using a model
$trend = Trend::model(User::class);

// Using a query builder
$trend = Trend::query(User::where('active', true));

The TrendValue class is a data object that represents a single point in a trend calculation. It encapsulates the specific date and the calculated aggregate value for that period.

It contains two properties:

• date: A string representing the date or time period of the trend point.
• aggregate: A mixed type value representing the result of the aggregation (e.g., a sum, count, or average) for that specific date.