Yiisoft\Strings\NumericHelper

Complexity

Total Complexity

14

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	normalize()	0	15	4
A	isInteger()	0	3	1
B	toOrdinal()	0	23	7
A	isPositiveInteger()	0	8	2

<?php

declare(strict_types=1);

namespace Yiisoft\Strings;

use InvalidArgumentException;
use function in_array;
use function is_bool;

/**
 * Provides static methods to work with numeric strings.
 */
final class NumericHelper
{
    /**
     * Converts number to its ordinal English form. For example, converts 13 to 13th, 2 to 2nd etc.
     *
     * @param float|int|string $value The number to get its ordinal value.
     *
     * @return string
     */
    public static function toOrdinal($value): string
    {
        if (!is_numeric($value)) {
            $type = gettype($value);
            throw new InvalidArgumentException("Value must be numeric. $type given.");
        }

        if (fmod((float)$value, 1) !== 0.00) {
            return (string)$value;
        }

        if (in_array($value % 100, [11, 12, 13], true)) {
            return $value . 'th';
        }
        switch ($value % 10) {
            case 1:
                return $value . 'st';
            case 2:
                return $value . 'nd';
            case 3:
                return $value . 'rd';
            default:
                return $value . 'th';
        }
    }

    /**
     * Returns string representation of a number value without thousands separators and with dot as decimal separator.
     *
     * @param bool|float|int|string $value
     *
     * @throws InvalidArgumentException if value is not scalar.
     *
     * @return string
     */
    public static function normalize($value): string
    {
        /** @psalm-suppress DocblockTypeContradiction */
        if (!is_scalar($value)) {

The condition is_scalar($value) is always true.

            $type = gettype($value);
            throw new InvalidArgumentException("Value must be scalar. $type given.");
        }

        if (is_bool($value)) {
            $value = $value ? '1' : '0';
        } else {
            $value = (string)$value;
        }
        $value = str_replace([' ', ','], ['', '.'], $value);
        return preg_replace('/\.(?=.*\.)/', '', $value);
    }

    /**
     * Checks whether the given value is an integer number.
     *
     * @param mixed $value
     *
     * @return bool
     */
    public static function isInteger($value): bool
    {
        return filter_var($value, FILTER_VALIDATE_INT) !== false;
    }

    /**
     * Checks whether the given string is a positive integer number.
     *
     * @param string $string
     *
     * @return bool
     */
    public static function isPositiveInteger(string $string): bool
    {
        // Exclude strings like "+5"
        if (!preg_match('/^\d+$/', $string)) {
            return false;
        }

        return filter_var($string, FILTER_VALIDATE_INT, ['options' => ['min_range' => 1]]) !== false;
    }
}