Money\Calculator\GmpCalculator Class Reference

Inheritance diagram for Money\Calculator\GmpCalculator:

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

Static Public Member Functions
static	supported ()

Detailed Description

Author

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

Definition at line 12 of file GmpCalculator.php.

Constructor & Destructor Documentation

__construct()

Money\Calculator\GmpCalculator::__construct

(

$scale = 14

)

Parameters

int

$scale

Definition at line 25 of file GmpCalculator.php.

Member Function Documentation

absolute()

Money\Calculator\GmpCalculator::absolute

(

$number

)

{Returns the absolute value of the number.

Parameters

string

$number

Returns

string

}

Implements Money\Calculator.

Definition at line 191 of file GmpCalculator.php.

Referenced by Money\Calculator\GmpCalculator\mod().

add()

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

{Add added to amount.

Parameters

string	$amount
string	$addend

Returns

string

}

Implements Money\Calculator.

Definition at line 64 of file GmpCalculator.php.

Referenced by Money\Calculator\GmpCalculator\ceil(), Money\Calculator\GmpCalculator\floor(), and Money\Calculator\GmpCalculator\round().

ceil()

Money\Calculator\GmpCalculator::ceil

(

$number

)

{Round number to following integer.

Parameters

string

$number

Returns

string

}

Implements Money\Calculator.

Definition at line 155 of file GmpCalculator.php.

References Money\Calculator\GmpCalculator\add(), and Money\Number\fromNumber().

compare()

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

{Compare a to b.

Parameters

string	$a
string	$b

Returns

int

}

Implements Money\Calculator.

Definition at line 41 of file GmpCalculator.php.

References Money\Number\fromNumber().

divide()

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

{Divide amount with divisor.

Parameters

string	$amount
int | float | string	$divisor

Returns

string

}

Implements Money\Calculator.

Definition at line 115 of file GmpCalculator.php.

References Money\Number\fromNumber().

Referenced by Money\Calculator\GmpCalculator\it_divides_bug538(), and Money\Calculator\GmpCalculator\share().

floor()

Money\Calculator\GmpCalculator::floor

(

$number

)

{Round number to preceding integer.

Parameters

string

$number

Returns

string

}

Implements Money\Calculator.

Definition at line 173 of file GmpCalculator.php.

References Money\Calculator\GmpCalculator\add(), and Money\Number\fromNumber().

Referenced by Money\Calculator\GmpCalculator\share().

it_divides_bug538()

Money\Calculator\GmpCalculator::it_divides_bug538

(

)

Test:

Definition at line 321 of file GmpCalculator.php.

References Money\Calculator\GmpCalculator\divide().

mod()

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

{Get the modulus of an amount.

Parameters

string	$amount
int | float | string	$divisor

Returns

string

}

Implements Money\Calculator.

Definition at line 303 of file GmpCalculator.php.

References Money\Calculator\GmpCalculator\absolute(), and Money\Number\fromNumber().

multiply()

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

{Multiply amount with multiplier.

Parameters

string	$amount
int | float | string	$multiplier

Returns

string

}

Implements Money\Calculator.

Definition at line 80 of file GmpCalculator.php.

References Money\Number\fromNumber().

Referenced by Money\Calculator\GmpCalculator\share().

round()

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

{Round number, use rounding mode for tie-breaker.

Parameters

int | float | string	$number
int	$roundingMode

Returns

string

}

Implements Money\Calculator.

Definition at line 199 of file GmpCalculator.php.

References Money\Calculator\GmpCalculator\add(), Money\Number\fromNumber(), Money\Money\ROUND_HALF_DOWN, Money\Money\ROUND_HALF_EVEN, Money\Money\ROUND_HALF_NEGATIVE_INFINITY, Money\Money\ROUND_HALF_ODD, Money\Money\ROUND_HALF_POSITIVE_INFINITY, and Money\Money\ROUND_HALF_UP.

share()

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

{Share amount among ratio / total portions.

Parameters

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

Returns

string

}

Implements Money\Calculator.

Definition at line 295 of file GmpCalculator.php.

References Money\Calculator\GmpCalculator\divide(), Money\Calculator\GmpCalculator\floor(), and Money\Calculator\GmpCalculator\multiply().

subtract()

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

{Subtract subtrahend from amount.

Parameters

string	$amount
string	$subtrahend

Returns

string

}

Implements Money\Calculator.

Definition at line 72 of file GmpCalculator.php.

supported()

static Money\Calculator\GmpCalculator::supported ( )

static

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

Returns

bool

}

Implements Money\Calculator.

Definition at line 33 of file GmpCalculator.php.

---

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

• GmpCalculator.php