PHP Luminova: Basic Mathematical Operations Helper with the Math Class

The Maths module offers a suite of essential mathematical functions to support your development needs. It includes fundamental methods for tasks such as currency and unit conversions, calculating discounts, interest, and more. These tools are designed to simplify common mathematical operations, with plans to expand functionality for advanced use cases in the future.

• Class namespace: \Luminova\Functions\Maths
• This class is marked as final and can't be subclassed

Methods

The methods can be accessed through global function helper, Factory instance or call statically.

<?php
func('math')->money(5000);
// 5000.00

Or directly call math method.

<?php
func()->math()->money(5000);
// 5000.00

Or using factory instance to initialize function and call math method.

<?php
use Luminova\Application\Factory;

Factory::functions()->math()->money(5000);
// 5000.00

Or continently call it statically.

<?php
use \Luminova\Functions\Maths;

Maths::money(5000);

toUnit

Converts bytes to the appropriate unit.

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

Parameters:

Return Value:

string - Return the converted value with optional unit name.

toBytes

Converts a unit name to bytes.

public static toBytes(string $units): int

Parameters:

Return Value:

int - Return the size in bytes.

toTimeUnit

Converts a given time in milliseconds to a human-readable format with appropriate time units (e.g., milliseconds, seconds, minutes, etc.).

public static toTimeUnit(float|int $milliseconds, bool $add_name = false, bool $full_name = false): string

Parameters:

Return Value:

string - Return the formatted time duration with up to two decimal precision.

average

Calculate the average of a giving numbers.

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

Parameters:

Return Value:

float|null - Return 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 - Return the average rating.

Example

The average of the below rating is: 8.50.

<?php 
echo Math::rating(5, 42.5, true)

money

Formats currency with decimal places and comma separation.

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

Parameters:

Return Value:

string - Return 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 - Return the formatted currency string, or false if unable to format.

crypto

Format a number to it's cryptocurrency length.

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

Parameters:

Return Value:

string|false - The equivalent amount in cryptocurrency.

Available Cryptos

• BTC - Bitcoin.
• ETH - Ethereum.
• LTC - Litecoin.
• XRP - Ripple Credits.
• DOGE - Doge Coin.

distance

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

public static distance(float|string $origin_lat, float|string $origin_lng, float|string $dest_lat, float|string $dest_lng, string $unit = 'km'): float|false

Parameters:

Return Value:

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

Supported units:

• 'km' - Kilometers,
• 'mi' - Miles,
• 'nmi' - Nautical miles.

Note: 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 - Return the formatted and rounded number.

discount

Calculate the discounted amount based on rate given.

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

Parameters:

Return Value:

float - Return the discounted amount.

interest

Calculate the total amount after adding an interest based on rete.

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

Parameters:

Return Value:

float - Return he total amount with an interest rate.