Added bitRate number helper

[alexjustesen]

📃 Description

This PR introduces a bitRate() number helper to convert a given bit value to a string representation. Example 1000 to 1 Kbps. This is modeled off of the existing fileSize() helper.

📖 Docs

laravel/docs#10846

[shaedrich]

You could reduce duplicated code

Suggested change

	$units = ['bps', 'Kbps', 'Mbps', 'Gbps', 'Tbps', 'Pbps', 'Ebps', 'Zbps', 'Ybps'];
	$unitCount = count($units);
	for ($i = 0; ($bits / 1000) > 0.9 && ($i < $unitCount - 1); $i++) {
	$bits /= 1000;
	}
	return sprintf('%s %s', static::format($bits, $precision, $maxPrecision), $units[$i]);
	$formatted = strtolower(static::fileSize($bits, $precision, $maxPrexision) . 'ps';
	return $bits < 1000 ? $formatted : ucwords($formatted);

[alexjustesen]

@shaedrich I didn't reuse the fileSize() method because bits and bytes are calculated differently. Bytes are calculated using binary base-2 (power of 1024) where bits are decimal base-10 (power of 1000).

Also the capitalization of the "b" matters as "Kb" = Kilobit and "KB" is Kilobyte etc.

[shaedrich]

Capitalization is taken care of as you can see, but you are right about the base.

This could probably be moved to a private utility method:

    /**
	 * @template TValue of string[]
	 * 
	 * @param TValue $values
	 *
     * @return array{int|float, value-of<TValue>}
     */
    private static function convertForDisplay(int|float $value, array $units, int $base)
    {
        $unitCount = count($units);

        for ($i = 0; ($value / $base) > 0.9 && ($i < $unitCount - 1); $i++) {
            $value /= $base;
        }

        return [$value, $units[$i]];
    }

but maybe, this is overkill

[alexjustesen]

My 2c I think the utility method might be useful if there is a 3rd method that relies on converting an integer to a string with a unit. Just my personal take 🤷‍♂️

Happy to do that in a separate PR and apply that to the fileSize() method as well.

[shaedrich]

Absolutely 👍🏻

[taylorotwell]

Thanks for your pull request to Laravel!

Unfortunately, I'm going to delay merging this code for now. To preserve our ability to adequately maintain the framework, we need to be very careful regarding the amount of code we include.

If applicable, please consider releasing your code as a package so that the community can still take advantage of your contributions!