LibreNMS/LibreNMS/Util/Number.php

129 lines
3.6 KiB
PHP

<?php
/*
* Number.php
*
* -Description-
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* @package LibreNMS
* @link https://www.librenms.org
* @copyright 2020 Tony Murray
* @author Tony Murray <murraytony@gmail.com>
*/
namespace LibreNMS\Util;
class Number
{
public static function formatBase($value, $base = 1000, $round = 2, $sf = 3, $suffix = 'B')
{
return $base == 1000
? self::formatSi($value, $round, $sf, $suffix)
: self::formatBi($value, $round, $sf, $suffix);
}
public static function formatSi($value, $round = 2, $sf = 3, $suffix = 'B')
{
$value = (float) $value;
$neg = $value < 0;
if ($neg) {
$value = $value * -1;
}
if ($value >= '0.1') {
$sizes = ['', 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y'];
$ext = $sizes[0];
for ($i = 1; (($i < count($sizes)) && ($value >= 1000)); $i++) {
$value = $value / 1000;
$ext = $sizes[$i];
}
} else {
$sizes = ['', 'm', 'u', 'n', 'p'];
$ext = $sizes[0];
for ($i = 1; (($i < count($sizes)) && ($value != 0) && ($value <= 0.1)); $i++) {
$value = $value * 1000;
$ext = $sizes[$i];
}
}
if ($neg) {
$value = $value * -1;
}
return self::cast(number_format(round($value, $round), $sf, '.', '')) . " $ext$suffix";
}
public static function formatBi($value, $round = 2, $sf = 3, $suffix = 'B')
{
$value = (float) $value;
$neg = $value < 0;
if ($neg) {
$value = $value * -1;
}
$sizes = ['', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi', 'Yi'];
$ext = $sizes[0];
for ($i = 1; (($i < count($sizes)) && ($value >= 1024)); $i++) {
$value = $value / 1024;
$ext = $sizes[$i];
}
if ($neg) {
$value = $value * -1;
}
return self::cast(number_format(round($value, $round), $sf, '.', '')) . " $ext$suffix";
}
/**
* Cast string to int or float.
* Returns 0 if string is not numeric
*
* @param string $number
* @return float|int
*/
public static function cast($number)
{
if (! is_numeric($number)) {
// match pre-PHP8 behavior
if (! preg_match('/^-?\d+(\.\d+)?/', $number, $matches)) {
return 0;
}
$number = $matches[0];
}
$float = (float) $number;
$int = (int) $number;
return $float == $int ? $int : $float;
}
/**
* Calculate a percent, but make sure to not divide by zero. In that case, return 0.
*
* @param int|float $part
* @param int|float $total
* @param int $precision
* @return float
*/
public static function calculatePercent($part, $total, int $precision = 2): float
{
if ($total == 0) {
return 0;
}
return round($part / $total * 100, $precision);
}
}