Arcanedev\LaravelMetrics\Metrics\Value

Complexity

Total Complexity

9

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	type()	0	4	1
A	count()	0	4	1
A	average()	0	4	1
A	sum()	0	4	1
A	max()	0	4	1
A	min()	0	4	1
A	aggregate()	0	9	2
A	result()	0	4	1

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelMetrics\Metrics;

use Arcanedev\LaravelMetrics\Metrics\Concerns\HasRoundedValue;
use Arcanedev\LaravelMetrics\Results\ValueResult;

/**
 * Class     Value
 *
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
abstract class Value extends Metric
{
    /* -----------------------------------------------------------------
     |  Traits
     | -----------------------------------------------------------------
     */

    use HasRoundedValue;

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the metric type.
     *
     * @return string
     */
    public function type(): string
    {
        return 'value';
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Calculate the `count` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string|string                                 $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\ValueResult|mixed
     */
    public function count($model, $column = null)
    {
        return $this->aggregate('count', $model, $column);
    }

    /**
     * Calculate the `average` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\ValueResult|mixed
     */
    public function average($model, string $column)
    {
        return $this->aggregate('avg', $model, $column);
    }

    /**
     * Calculate the `sum` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\ValueResult|mixed
     */
    public function sum($model, string $column)
    {
        return $this->aggregate('sum', $model, $column);
    }

    /**
     * Calculate the `max` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\ValueResult|mixed
     */
    public function max($model, string $column)
    {
        return $this->aggregate('max', $model, $column);
    }

    /**
     * Calculate the `min` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\ValueResult|mixed
     */
    public function min($model, string $column)
    {
        return $this->aggregate('min', $model, $column);
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Handle the aggregate calculation of the metric.
     *
     * @param string                                         $method
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string|null                                   $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\ValueResult|mixed
     */
    protected function aggregate(string $method, $model, string $column = null)
    {
        $query  = static::getQuery($model);
        $column = $column ?? $query->getModel()->getQualifiedKeyName();

The method getQualifiedKeyName does only exist in Illuminate\Database\Eloquent\Model, but not in Illuminate\Database\Eloquent\Builder.

        $value  = $query->{$method}($column);

        return $this->result($method === 'count' ? $value : $this->roundValue($value));
    }

    /**
     * Make a new result instance.
     *
     * @param  mixed|null  $value
     *
     * @return \Arcanedev\LaravelMetrics\Results\ValueResult|mixed
     */
    protected function result($value = null)
    {
        return new ValueResult($value);
    }
}