TraderInteractive\Filter\Floats

Complexity

Total Complexity

14

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
C	filter()	0	48	14

<?php

namespace TraderInteractive\Filter;

use TraderInteractive\Exceptions\FilterException;

/**
 * A collection of filters for floats.
 */
final class Floats
{
    /**
     * Filters $value to a float strictly.
     *
     * The return value is the float, as expected by the \TraderInteractive\Filterer class.
     *
     * @param string|float $value     the value to filter to a float
     * @param bool         $allowNull Set to true if NULL values are allowed. The filtered result of a NULL value is
     *                                NULL
     * @param float        $minValue  The minimum acceptable value
     * @param float        $maxValue  The maximum acceptable value
     * @param bool         $castInts  Flag to cast $value to float if it is an integer
     *
     * @return float|null The filtered value
     *
     * @throws FilterException if $value is greater than $maxValue
     * @see is_numeric
     */
    public static function filter(
        $value,
        bool $allowNull = false,
        float $minValue = null,
        float $maxValue = null,
        bool $castInts = false
    ) {
        if ($allowNull === true && $value === null) {

The condition $allowNull === true && $value === null can never be true.

            return null;
        }

        $valueFloat = null;
        if (is_float($value)) {
            $valueFloat = $value;
        } elseif (is_int($value) && $castInts) {

The condition is_int($value) && $castInts can never be true.

            $valueFloat = (float)$value;
        } elseif (is_string($value)) {

The condition is_string($value) can never be false.

            $value = trim($value);

            if (!is_numeric($value)) {
                throw new FilterException("{$value} does not pass is_numeric");
            }

            $value = strtolower($value);

            //This is the only case (that we know of) where is_numeric does not return correctly cast-able float
            if (strpos($value, 'x') !== false) {
                throw new FilterException("{$value} is hex format");
            }

            $valueFloat = (float)$value;
        } else {
            throw new FilterException('"' . var_export($value, true) . '" $value is not a string');
        }

        if (is_infinite($valueFloat)) {
            throw new FilterException("{$value} overflow");
        }

        if ($minValue !== null && $valueFloat < $minValue) {
            throw new FilterException("{$valueFloat} is less than {$minValue}");
        }

        if ($maxValue !== null && $valueFloat > $maxValue) {
            throw new FilterException("{$valueFloat} is greater than {$maxValue}");
        }

        return $valueFloat;
    }
}