Helpers.php

Go to the documentation of this file.

<?php

namespace PhpOffice\PhpSpreadsheet\Calculation\MathTrig;

use PhpOffice\PhpSpreadsheet\Calculation\Exception;
use PhpOffice\PhpSpreadsheet\Calculation\Functions;

class Helpers
{
    public static function verySmallDenominator(float $numerator, float $denominator)
    {
        return (abs($denominator) < 1.0E-12) ? Functions::DIV0() : ($numerator / $denominator);
    }

    public static function validateNumericNullBool($number)
    {
        $number = Functions::flattenSingleValue($number);
        if ($number === null) {
            return 0;
        }
        if (is_bool($number)) {
            return (int) $number;
        }
        if (is_numeric($number)) {
            return 0 + $number;
        }

        throw new Exception(Functions::VALUE());
    }

    public static function validateNumericNullSubstitution($number, $substitute)
    {
        $number = Functions::flattenSingleValue($number);
        if ($number === null && $substitute !== null) {
            return $substitute;
        }
        if (is_numeric($number)) {
            return 0 + $number;
        }

        throw new Exception(Functions::VALUE());
    }

    public static function validateNotNegative($number, ?string $except = null): void
    {
        if ($number >= 0) {
            return;
        }

        throw new Exception($except ?? Functions::NAN());
    }

    public static function validatePositive($number, ?string $except = null): void
    {
        if ($number > 0) {
            return;
        }

        throw new Exception($except ?? Functions::NAN());
    }

    public static function validateNotZero($number): void
    {
        if ($number) {
            return;
        }

        throw new Exception(Functions::DIV0());
    }

    public static function returnSign(float $number): int
    {
        return $number ? (($number > 0) ? 1 : -1) : 0;
    }

    public static function getEven(float $number): float
    {
        $significance = 2 * self::returnSign($number);

        return $significance ? (ceil($number / $significance) * $significance) : 0;
    }

    public static function numberOrNan($result)
    {
        return is_nan($result) ? Functions::NAN() : $result;
    }
}