Money\Calculator Interface Reference

Inheritance diagram for Money\Calculator:

Public Member Functions
	absolute ($number)
	add ($amount, $addend)
	ceil ($number)
	compare ($a, $b)
	divide ($amount, $divisor)
	floor ($number)
	mod ($amount, $divisor)
	multiply ($amount, $multiplier)
	round ($number, $roundingMode)
	share ($amount, $ratio, $total)
	subtract ($amount, $subtrahend)

Static Public Member Functions
static	supported ()

Detailed Description

Money calculations abstracted away from the Money value object.

Author

Frederik Bosch f.bos.nosp@m.ch@g.nosp@m.enkgo.nosp@m..nl

Definition at line 10 of file Calculator.php.

Member Function Documentation

absolute()

Money\Calculator::absolute

(

$number

)

Returns the absolute value of the number.

Parameters

string

$number

Returns

string

Implemented in Money\Calculator\GmpCalculator, Money\Calculator\BcMathCalculator, and Money\Calculator\PhpCalculator.

add()

Money\Calculator::add	(		$amount,
			$addend
	)

Add added to amount.

Parameters

string	$amount
string	$addend

Returns

string

Implemented in Money\Calculator\GmpCalculator, Money\Calculator\BcMathCalculator, and Money\Calculator\PhpCalculator.

ceil()

Money\Calculator::ceil

(

$number

)

Round number to following integer.

Parameters

string

$number

Returns

string

Implemented in Money\Calculator\GmpCalculator, Money\Calculator\BcMathCalculator, and Money\Calculator\PhpCalculator.

compare()

Money\Calculator::compare	(		$a,
			$b
	)

Compare a to b.

Parameters

string	$a
string	$b

Returns

int

Implemented in Money\Calculator\BcMathCalculator, Money\Calculator\GmpCalculator, and Money\Calculator\PhpCalculator.

divide()

Money\Calculator::divide	(		$amount,
			$divisor
	)

Divide amount with divisor.

Parameters

string	$amount
int | float | string	$divisor

Returns

string

Implemented in Money\Calculator\GmpCalculator, Money\Calculator\BcMathCalculator, and Money\Calculator\PhpCalculator.

floor()

Money\Calculator::floor

(

$number

)

Round number to preceding integer.

Parameters

string

$number

Returns

string

Implemented in Money\Calculator\GmpCalculator, Money\Calculator\BcMathCalculator, and Money\Calculator\PhpCalculator.

mod()

Money\Calculator::mod	(		$amount,
			$divisor
	)

Get the modulus of an amount.

Parameters

string	$amount
int | float | string	$divisor

Returns

string

Implemented in Money\Calculator\GmpCalculator, Money\Calculator\BcMathCalculator, and Money\Calculator\PhpCalculator.

multiply()

Money\Calculator::multiply	(		$amount,
			$multiplier
	)

Multiply amount with multiplier.

Parameters

string	$amount
int | float | string	$multiplier

Returns

string

Implemented in Money\Calculator\GmpCalculator, Money\Calculator\BcMathCalculator, and Money\Calculator\PhpCalculator.

round()

Money\Calculator::round	(		$number,
			$roundingMode
	)

Round number, use rounding mode for tie-breaker.

Parameters

int | float | string	$number
int	$roundingMode

Returns

string

Implemented in Money\Calculator\GmpCalculator, Money\Calculator\BcMathCalculator, and Money\Calculator\PhpCalculator.

share()

Money\Calculator::share	(		$amount,
			$ratio,
			$total
	)

Share amount among ratio / total portions.

Parameters

string	$amount
int | float | string	$ratio
int | float | string	$total

Returns

string

Implemented in Money\Calculator\GmpCalculator, Money\Calculator\BcMathCalculator, and Money\Calculator\PhpCalculator.

subtract()

Money\Calculator::subtract	(		$amount,
			$subtrahend
	)

Subtract subtrahend from amount.

Parameters

string	$amount
string	$subtrahend

Returns

string

Implemented in Money\Calculator\GmpCalculator, Money\Calculator\BcMathCalculator, and Money\Calculator\PhpCalculator.

supported()

static Money\Calculator::supported ( )

static

Returns whether the calculator is supported in the current server environment.

Returns

bool

Implemented in Money\Calculator\BcMathCalculator, Money\Calculator\GmpCalculator, and Money\Calculator\PhpCalculator.

---

The documentation for this interface was generated from the following file:

• Calculator.php