insenseanalytics / nova-bar-metrics

src/HasFrequencyDistributions.php

<?php

namespace Insenseanalytics\NovaBarMetrics;

use Illuminate\Support\Facades\DB;

The type Illuminate\Support\Facades\DB was not found. Maybe you did not declare it correctly or list all dependencies?

use Illuminate\Database\Eloquent\Builder;

The type Illuminate\Database\Eloquent\Builder was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Use only with partition metrics or metrics derived from the Partition class
 * like BarChartMetric.
 */
trait HasFrequencyDistributions
{
    /**
     * Return a partition/derived result showing the segments of a frequency range.
     *
     * @param \Illuminate\Http\Request                     $request

The type Illuminate\Http\Request was not found. Maybe you did not declare it correctly or list all dependencies?

     * @param \Illuminate\Database\Eloquent\Builder|string $model
     * @param string                                       $column
     * @param int                                          $stepSize
     *
     * @return \Laravel\Nova\Metrics\PartitionResult

The type Laravel\Nova\Metrics\PartitionResult was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function distributions($request, $model, $column, $stepSize)
    {
        $subQuery = $model instanceof Builder ? $model : (new $model())->newQuery();

        $expression = FrequencyDistributionExpressionFactory::make(
            $subQuery,
            $column,
            $stepSize
        )->getValue();

        $subQuery = $subQuery
            ->select(DB::raw("{$expression['range']} as rng, 
                {$expression['minVal']} as minval, count(*) as aggregate"))
            ->groupBy(DB::raw('1'), DB::raw('2'));

        $query = DB::table(DB::raw("({$subQuery->toSql()}) as sub"))
            ->mergeBindings($subQuery->getQuery());

        $results = $query
            ->select('rng', 'aggregate', 'minval')
            ->orderBy('minval', 'asc')
            ->get();

        return $this->result($results->mapWithKeys(function ($result) use ($column) {

It seems like result() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return $this->formatAggregateResult($result, 'rng');

It seems like formatAggregateResult() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        })->all());
    }

    /**
     * Return a partition/derived result showing the segments of a frequency range.
     *
     * @param \Illuminate\Http\Request                     $request
     * @param \Illuminate\Database\Eloquent\Builder|string $model
     * @param string                                       $column
     * @param int                                          $maxSteps
     *
     * @return \Laravel\Nova\Metrics\PartitionResult
     */
    public function distributionsWithSteps($request, $model, $column, $maxSteps = 15)
    {
        $query = $model instanceof Builder ? $model : (new $model())->newQuery();

        $difference = $query->max($column) - $query->min($column);

        if (!$difference) {
            $stepSize = 1;
        } else {
            $stepSize = round($difference / $maxSteps, 0);
        }

        return $this->distributions($request, $query, $column, $stepSize);

It seems like $stepSize can also be of type double; however, parameter $stepSize of Insenseanalytics\NovaBarMetrics\HasFrequencyDistributions::distributions() does only seem to accept integer, maybe add an additional type check?

    }
}