Maths Helper

This class provides a set of fundamental mathematical calculation methods currency conversions and unit conversions. They are designed to assist developers in performing common mathematical tasks while we add more for advance usages.

• Class namespace: \Luminova\Functions\Maths

Methods

toUnit

Converts bytes to the appropriate unit.

public static toUnit(int $bytes, bool $add_name = false): string

Parameters:

Return Value:

string - The converted value with optional unit name.

toBytes

Converts a unit name to bytes.

public static toBytes(string $units): int

Parameters:

Return Value:

int - The size in bytes.

average

Calculate the average of a giving numbers.

public static average(int|float $numbers): float|null

Parameters:

Return Value:

float|null - The average of the passed numbers.

rating

Calculate the average rating based on the number of reviews and total rating points.

public static rating(int $reviews, float $rating, bool $round = false): float

Parameters:

Return Value:

float - The average rating.

money

Formats currency with decimal places and comma separation.

public static money(mixed $amount, bool $decimals = 2): string

Parameters:

Return Value:

string - Formatted currency string.

currency

Format a number as a currency string using your application local as the default currency locale.

public static currency(float $number, string $code = 'USD', string|null $locale = null): string|false

Parameters:

Return Value:

string|false - The formatted currency string, or false if unable to format.

crypto

Convert a number to cryptocurrency.

public static crypto(int|float|string $amount, string $network = 'BTC'): float|false

Parameters:

Return Value:

float|false - The equivalent amount in cryptocurrency.

distance

Calculate the distance between two points on the Earth's surface.

public static distance(float|string $olat, float|string $olon, float|string $dlat, float|string $dlon, string $unit = 'km'): float|false

Parameters:

Return Value:

float|false - The distance between the two points, or false on invalid input.

If you are passing a string, make sure its a float string.

fixed

Format a number with optional rounding.

public static fixed(float|int|string $number, int|null $decimals = null): string

Parameters:

Return Value:

string - The formatted number.

discount

Calculate the discounted amount.

public static discount(float|int|string $total, float|int|string $rate): float

Parameters:

Return Value:

float - The discounted amount.

interest

Calculate the total amount after adding interest.

public static interest(float|int|string $total, float|int|string $rate): float

Parameters:

Return Value:

float - The total amount after adding interest.