#Numbers

Phuture\Coherence\Type\Numbers

class Numbers extends FluentClass implements Numberable

A fluent wrapper around the Numbers utility class for chainable number manipulation.

Each method delegates to the corresponding static method on Numbers, stores the result internally, and returns $this to enable method chaining. Retrieve the final value by calling get(), toFloat(), toInt(), or toNumber().

Arithmetic methods (add, subtract, multiply, divide, modulus, squareRoot) use BCMath internally and store their result as a string. Subsequent operations that require a numeric value will cast the stored string automatically.

Example:

1use Phuture\Coherence\Type\Numbers;
2
3$result = Numbers::from(10)
4    ->add(5)
5    ->multiply(2)
6    ->subtract(3)
7    ->round(0)
8    ->get();
9// 27.0

#Methods

#absolute()

public function absolute(): self

Returns the absolute (non-negative) value of the wrapped number.

Returns self — Returns the current instance for method chaining

See also

• Transformer::absolute()

#add()

public function add(int|float $value): self

Adds a number to the wrapped value using BCMath for precision.

Returns self — Returns the current instance for method chaining

See also

• Transformer::add()

#addPercentage()

public function addPercentage(int|float $percentage): self

Adds a percentage of the wrapped value to itself using BCMath for precision.

Returns self — Returns the current instance for method chaining

See also

• Transformer::addPercentage()

#ceil()

public function ceil(): self

Returns the smallest integer value greater than or equal to the wrapped number.

Returns self — Returns the current instance for method chaining (stores result as a BCMath string)

See also

• Transformer::ceil()

#celsiusToFahrenheit()

public function celsiusToFahrenheit(): self

Converts the wrapped Celsius temperature to Fahrenheit using BCMath for precision.

The conversion result replaces the wrapped value, enabling further chaining with arithmetic or formatting methods.

Returns self — Returns the current instance for method chaining

See also

• Transformer::celsiusToFahrenheit()

#celsiusToRankine()

public function celsiusToRankine(): self

Converts the wrapped Celsius temperature to Rankine using BCMath for precision.

The conversion result replaces the wrapped value, enabling further chaining with arithmetic or formatting methods.

Returns self — Returns the current instance for method chaining

See also

• Transformer::celsiusToRankine()

#clamp()

public function clamp(int|float $min, int|float $max): self

Restricts the wrapped number to be within the given minimum and maximum bounds.

Returns self — Returns the current instance for method chaining

See also

• Transformer::clamp()

#compare()

public function compare(int|float $value): int

Compares the wrapped number with another and returns their relative order.

Returns int — -1 when wrapped < $value, 0 when equal, 1 when wrapped > $value

See also

• Transformer::compare()

#convert()

public function convert(Unit $from, Unit $to): self

Converts the wrapped value from one unit of measurement to another.

The conversion result replaces the wrapped value, enabling further chaining with arithmetic or formatting methods.

Example:

 1use Phuture\Coherence\Enum\Unit;
 2use Phuture\Coherence\Type\Numbers;
 3
 4$fahrenheit = Numbers::from(100)
 5    ->convert(Unit::Celsius, Unit::Fahrenheit)
 6    ->get();
 7// '212.0000000000'
 8
 9$miles = Numbers::from(5)
10    ->convert(Unit::Kilometer, Unit::Mile)
11    ->round(2)
12    ->get();
13// '3.1100000000'

Returns self — Returns the current instance for method chaining

See also

• Transformer::convert() — For the static conversion method
• \Phuture\Coherence\Enum\Unit — For all available unit cases

#divide()

public function divide(int|float $value): self

Divides the wrapped number by another using BCMath for precision.

Returns self — Returns the current instance for method chaining

See also

• Transformer::divide()

#fahrenheitToCelsius()

public function fahrenheitToCelsius(): self

Converts the wrapped Fahrenheit temperature to Celsius using BCMath for precision.

The conversion result replaces the wrapped value, enabling further chaining with arithmetic or formatting methods.

Returns self — Returns the current instance for method chaining

See also

• Transformer::fahrenheitToCelsius()

#fileSize()

public function fileSize(int $precision = 0, ByteBase $base = ByteBase::Binary): string

Converts the wrapped byte count into a human-readable file size string.

Returns string — The human-readable file size string

See also

• Transformer::fileSize()
• \Phuture\Coherence\Enum\ByteBase

#floor()

public function floor(): self

Returns the largest integer value less than or equal to the wrapped number.

Returns self — Returns the current instance for method chaining (stores result as a BCMath string)

See also

• Transformer::floor()

#forHumans()

public function forHumans(int $precision = 1): string

Converts the wrapped number into a human-readable string with unit names.

Returns string — The human-readable number string

See also

• Transformer::forHumans()

#format()

public function format(?int $precision = null): string

Formats the wrapped number with grouped thousands and a specified precision.

Returns string — The formatted number string

See also

• Transformer::format()

#formatPercentage()

public function formatPercentage(int $precision = 1, int $multiplicand = 100): string

Converts the wrapped number into a human-readable percentage string.

Returns string — The formatted percentage string

See also

• Transformer::formatPercentage()

#max()

public function max(int|float $value): self

Returns the higher of the wrapped number and another.

Returns self — Returns the current instance for method chaining

See also

• Transformer::max()

#min()

public function min(int|float $value): self

Returns the lower of the wrapped number and another.

Returns self — Returns the current instance for method chaining

See also

• Transformer::min()

#modulus()

public function modulus(int|float $value): self

Computes the modulus of the wrapped number divided by another using BCMath.

Returns self — Returns the current instance for method chaining

See also

• Transformer::modulus()

#multiply()

public function multiply(int|float $value): self

Multiplies the wrapped number by another using BCMath for precision.

Returns self — Returns the current instance for method chaining

See also

• Transformer::multiply()

#opposite()

public function opposite(): self

Returns the arithmetic opposite (negation) of the wrapped number.

Returns self — Returns the current instance for method chaining

See also

• Transformer::opposite()

#ordinal()

public function ordinal(): string

Converts the wrapped integer to its ordinal string representation.

Returns string — The ordinal string with the appropriate suffix

See also

• Transformer::ordinal()

#percentage()

public function percentage(int|float $percentage): self

Calculates the given percentage of the wrapped value using BCMath for precision.

Replaces the wrapped value with the computed percentage amount.

Returns self — Returns the current instance for method chaining

See also

• Transformer::percentage()

#rankineToCelsius()

public function rankineToCelsius(): self

Converts the wrapped Rankine temperature to Celsius using BCMath for precision.

The conversion result replaces the wrapped value, enabling further chaining with arithmetic or formatting methods.

Returns self — Returns the current instance for method chaining

See also

• Transformer::rankineToCelsius()

#round()

public function round(int $precision = 0, RoundingMode $mode = RoundingMode::HalfAwayFromZero): self

Rounds the wrapped number to the specified precision using the given rounding mode.

Returns self — Returns the current instance for method chaining (stores result as a BCMath string)

See also

• Transformer::round()

#squareRoot()

public function squareRoot(int $scale = 10): self

Computes the square root of the wrapped number using BCMath for precision.

Returns self — Returns the current instance for method chaining

See also

• Transformer::squareRoot()

#subtract()

public function subtract(int|float $value): self

Subtracts a number from the wrapped value using BCMath for precision.

Returns self — Returns the current instance for method chaining

See also

• Transformer::subtract()

#subtractPercentage()

public function subtractPercentage(int|float $percentage): self

Subtracts a percentage of the wrapped value from itself using BCMath for precision.

Returns self — Returns the current instance for method chaining

See also

• Transformer::subtractPercentage()

#toFloat()

public function toFloat(): float

Converts the wrapped value to a float.

Returns float — The float representation of the wrapped value

#toInt()

public function toInt(): int

Converts the wrapped value to an integer.

Returns int — The integer representation of the wrapped value

#toNumber()

public function toNumber(): self

Normalizes the wrapped value to its most appropriate numeric type.

Returns self — Returns the current instance for method chaining

See also

• Transformer::toNumber()

#toString()

public function toString(): string

Converts the wrapped value to a string.

Returns string — The string representation of the wrapped value