insenseanalytics / nova-bar-metrics

src/BarChartMetricResult.php

<?php

namespace Insenseanalytics\NovaBarMetrics;

use Laravel\Nova\Metrics\PartitionResult;

class BarChartMetricResult extends PartitionResult
{
    /**
     * The metric value prefix.
     *
     * @var string
     */
    public $prefix;

    /**
     * The metric value suffix.
     *
     * @var string
     */
    public $suffix;

    /**
     * The precision of the average metric.
     *
     * @var int
     */
    public $precision = 2;

    /**
     * Set the metric value prefix.
     *
     * @param string $prefix
     *
     * @return $this
     */
    public function prefix($prefix)
    {
        $this->prefix = $prefix;

        return $this;
    }

    /**
     * Set the metric value suffix.
     *
     * @param string $suffix
     *
     * @return $this
     */
    public function suffix($suffix)
    {
        $this->suffix = $suffix;

        return $this;
    }

    /**
     * Set the precision of the average metric.
     *
     * @param int $precision
     *
     * @return $this
     */
    public function precision($precision)
    {
        $this->precision = $precision;

        return $this;
    }

    /**
     * Indicate that the metric represents a dollar value.
     *
     * @param string $symbol
     *
     * @return $this
     */
    public function dollars($symbol = '$')
    {
        return $this->prefix($symbol);
    }

    /**
     * Indicate that the metric represents a euro value.
     *
     * @param string $symbol
     *
     * @return $this
     */
    public function euros($symbol = '€')
    {
        return $this->prefix($symbol);
    }

    /**
     * Indicate that the metric represents a rupee value.
     *
     * @param string $symbol
     *
     * @return $this
     */
    public function rupees($symbol = '₹')
    {
        return $this->prefix($symbol);
    }

    /**
     * Prepare the metric result for JSON serialization.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return [
            'value' => collect($this->value ?? [])->map(function ($value, $label) {
                return ['label' => $label, 'value' => $value];
            })->values()->all(),
            'prefix' => $this->prefix,
            'suffix' => $this->suffix,
            'precision' => $this->precision,
        ];
    }

    /**
     * Format the range labels to friendly numbers (K for 1000s, M for millions, B for billions).
     *
     * @return array
     */
    public function withFormattedRangeLabels($labelPrecision = 0)
    {
        $newData = [];

        foreach (($this->value ?? []) as $label => $value) {
            $labelParts = explode('-', $label);
            if (2 == count($labelParts)) {
                $newLabel = $this->formatStrNumber($labelParts[0], $labelPrecision) . ' - ' .
                    $this->formatStrNumber($labelParts[1], $labelPrecision);
                $newData[$newLabel] = isset($newData[$newLabel]) ? ($value + $newData[$newLabel]) :
                    $value;
            }
        }

        $this->value = $newData;

The property value does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $this;

The expression return $this returns the type Insenseanalytics\NovaBarMetrics\BarChartMetricResult which is incompatible with the documented return type array.

    }

    /**
     * Helper function to format a string number.
     *
     * @return string
     */
    protected function formatStrNumber($number, $labelPrecision)
    {
        $n = intval(trim($number));

        if ($n < 999) {
            return $n . '';
        } elseif ($n < 999999) {
            // anything less than a million
            return number_format($n / 1000, $labelPrecision) . 'K';
        } elseif ($n < 999999999) {
            // anything less than a billion
            return number_format($n / 1000000, $labelPrecision) . 'M';
        } else {
            // At least a billion
            return number_format($n / 1000000000, $labelPrecision) . 'B';
        }
    }
}