TraderInteractive\Filter\Ints

Complexity

Total Complexity

16

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
C	filter()	0	55	16

<?php

namespace TraderInteractive\Filter;

use TraderInteractive\Exceptions\FilterException;

/**
 * A collection of filters for integers.
 */
final class Ints
{
    /**
     * Filters $value to an integer strictly.
     *
     * $value must be an int or contain all digits, optionally prepended by a '+' or '-' and optionally surrounded by
     * whitespace to pass the filter.
     *
     * The return value is the int, as expected by the \TraderInteractive\Filterer class.
     *
     * @param string|int $value     the value to make an integer
     * @param bool       $allowNull Set to true if NULL values are allowed. The filtered result of a NULL value is NULL
     * @param int        $minValue  The minimum acceptable value
     * @param int        $maxValue  The maximum acceptable value
     *
     * @return int|null The filtered value
     *
     * @throws FilterException if $value string length is zero
     * @throws FilterException if $value does not contain all digits, optionally prepended by a '+' or '-' and
     *                         optionally surrounded by whitespace
     * @throws FilterException if $value was greater than a max int of PHP_INT_MAX
     * @throws FilterException if $value was less than a min int of ~PHP_INT_MAX
     * @throws FilterException if $value is not a string
     * @throws FilterException if $value is less than $minValue
     * @throws FilterException if $value is greater than $maxValue
     */
    public static function filter($value, bool $allowNull = false, int $minValue = null, int $maxValue = PHP_INT_MAX)
    {
        if ($allowNull === true && $value === null) {

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

            return null;
        }

        $valueInt = null;
        if (is_int($value)) {
            $valueInt = $value;
        } elseif (is_string($value)) {

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

            $value = trim($value);

            if (strlen($value) === 0) {
                throw new FilterException('$value string length is zero');
            }

            $stringToCheckDigits = $value;

            if ($value[0] === '-' || $value[0] === '+') {
                $stringToCheckDigits = substr($value, 1);
            }

            if (!ctype_digit($stringToCheckDigits)) {
                throw new FilterException(
                    "{$value} does not contain all digits, optionally prepended by a '+' or '-' and optionally "
                    . "surrounded by whitespace"
                );
            }

            $phpIntMin = ~PHP_INT_MAX;

            $casted = (int)$value;

            if ($casted === PHP_INT_MAX && $value !== (string)PHP_INT_MAX) {
                throw new FilterException("{$value} was greater than a max int of " . PHP_INT_MAX);
            }

            if ($casted === $phpIntMin && $value !== (string)$phpIntMin) {
                throw new FilterException("{$value} was less than a min int of {$phpIntMin}");
            }

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

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

        if ($valueInt > $maxValue) {
            throw new FilterException("{$valueInt} is greater than {$maxValue}");
        }

        return $valueInt;
    }
}