add functions

Author: MartkCz

src/LazyArrayAccess.php

@@ -6,25 +6,39 @@
 use ArrayIterator;
 use IteratorAggregate;
 
+/**
+ * @template T
+ * @implements ArrayAccess<T>
+ */
 final class LazyArrayAccess implements ArrayAccess
 {
 
-	/** @var callable */
+	/** @var callable(): T */
 	private $callback;
 
-	private mixed $arrayAccess;
+	/** @var T[] */
+	private array $cache;
 
+	/**
+	 * @param callable(): T
+	 */
 	public function __construct(callable $callback)
 	{
 		$this->callback = $callback;
 	}
 
-	public function getSource(): mixed
+	/**
+	 * @return T[]|ArrayAccess<T>
+	 */
+	public function getSource(): array|ArrayAccess
 	{
 		return ($this->callback)();
 	}
 
-	private function getArrayAccess(): mixed
+	/**
+	 * @return T[]|ArrayAccess<T>
+	 */
+	private function getArrayAccess(): array|ArrayAccess
 	{
 		if (!isset($this->arrayAccess)) {
 			$result = ($this->callback)();
@@ -43,11 +57,17 @@ public function offsetExists(mixed $offset): bool
 		return isset($this->getArrayAccess()[$offset]) || array_key_exists($offset, $this->array);
 	}
 
+	/**
+	 * @return T
+	 */
 	public function offsetGet(mixed $offset): mixed
 	{
 		return $this->getArrayAccess()[$offset];
 	}
 
+	/**
+	 * @param T $value
+	 */
 	public function offsetSet(mixed $offset, mixed $value): void
 	{
 		$this->getArrayAccess();

src/Numbers.php

@@ -2,12 +2,28 @@
 
 namespace Utilitte\Php;
 
+use InvalidArgumentException;
 use JetBrains\PhpStorm\Deprecated;
 use Utilitte\Php\Numbers\NumberFormatter;
 
 final class Numbers
 {
 
+	public static function convertToFloat(string|int|float $number): float
+	{
+		if (!is_numeric($number)) {
+			throw new InvalidArgumentException('Given argument is not a number.');
+		}
+
+		$number = (float) $number;
+
+		if (is_nan($number) || is_infinite($number)) {
+			throw new InvalidArgumentException('Given argument is not a number.');
+		}
+
+		return $number;
+	}
+
 	public static function minMax(int $value, int $min, int $max): int
 	{
 		return min(max($value, $min), $max);

src/Numbers/NumberFormatter.php

@@ -2,16 +2,20 @@
 
 namespace Utilitte\Php\Numbers;
 
+use InvalidArgumentException;
 use LogicException;
+use Utilitte\Php\Numbers;
 
 final class NumberFormatter
 {
 
-	public static function formatBytes(int|float $number, ?int $decimals = null, bool $fixed = false): string
+	public static function formatBytes(string|int|float $number, ?int $decimals = null, bool $fixed = true): string
 	{
 		static $end = 'PB';
 		static $units = ['B', 'kB', 'MB', 'GB', 'TB', 'PB'];
 
+		$number = Numbers::convertToFloat($number);
+
 		$unit = 'B';
 		foreach ($units as $unit) {
 			if (abs($number) < 1024 || $unit === $end) {
@@ -21,10 +25,10 @@ public static function formatBytes(int|float $number, ?int $decimals = null, boo
 			$number /= 1024;
 		}
 
-		return self::formatNumber($number, $decimals, $fixed). $unit;
+		return self::formatNumber($number, $decimals, $fixed) . $unit;
 	}
 
-	public static function formatShort(int|float $number, ?int $decimals = null, bool $fixed = false): string
+	public static function formatShort(string|int|float $number, ?int $decimals = null, bool $fixed = true): string
 	{
 		static $formatters = [
 			'' => 1_000,
@@ -34,6 +38,7 @@ public static function formatShort(int|float $number, ?int $decimals = null, boo
 			'T' => null,
 		];
 
+		$number = Numbers::convertToFloat($number);
 		$divider = 1;
 		foreach ($formatters as $str => $limit) {
 			if ($limit === null || $number < $limit) {
@@ -47,48 +52,35 @@ public static function formatShort(int|float $number, ?int $decimals = null, boo
 	}
 
 	public static function formatPercentage(
-		string|int|float|null $number,
-		int $decimals = 2,
-		bool $sign = true,
+		string|int|float $number,
+		?int $decimals = null,
 		bool $fixed = true,
-	): ?string
+		bool $sign = false,
+	): string
 	{
-		if ($number === null || is_string($number) && !is_numeric($number)) {
-			return null;
-		}
-
-		$value = self::formatNumber($number, $decimals, $fixed);
-
-		if ($value === null) {
-			return null;
-		}
-
-		return ($sign && $number > 0 ? '+' : '') . $value . '%';
+		return self::formatNumber($number, $decimals, $fixed) . '%';
 	}
 
-	public static function formatNumber(string|int|float|null $number, ?int $decimals = null, bool $fixed = false): ?string
+	public static function formatNumber(
+		string|int|float|null $number,
+		?int $decimals = null,
+		bool $fixed = true,
+		bool $sign = false,
+	): string
 	{
-		if (!is_numeric($number)) {
-			return null;
-		}
-
-		$number = (float) $number;
-
-		if (is_nan($number) || is_infinite($number)) {
-			return null;
-		}
+		$number = Numbers::convertToFloat($number);
 
 		if ($decimals === null) {
-			$decimals = 2;
-
-			if ($number < 0.01) {
-				$decimals = 6;
-			} elseif ($number < 0.1) {
+			if ($fixed === true) {
+				$decimals = 0;
+			} elseif ($number < 0.01) {
 				$decimals = 5;
-			} elseif ($number < 1) {
+			} elseif ($number < 0.1) {
 				$decimals = 4;
-			} elseif ($number < 10) {
+			} elseif ($number < 1) {
 				$decimals = 3;
+			} else {
+				$decimals = 2;
 			}
 		}
 
@@ -98,7 +90,7 @@ public static function formatNumber(string|int|float|null $number, ?int $decimal
 			$number = self::removeZerosAfterDot($number);
 		}
 
-		return $number;
+		return ($sign && $number > 0 ? '+' : '') . $number . '%';
 	}
 
 	public static function removeZerosAfterDot(string $number): string