Open Journal Systems  3.3.0
Public Member Functions | Static Public Member Functions
Money\Calculator\PhpCalculator Class Reference
Inheritance diagram for Money\Calculator\PhpCalculator:
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

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

Definition at line 12 of file PhpCalculator.php.

Member Function Documentation

◆ absolute()

Money\Calculator\PhpCalculator::absolute (   $number)

{Returns the absolute value of the number.

Parameters
string$number
Returns
string
}

Implements Money\Calculator.

Definition at line 97 of file PhpCalculator.php.

◆ add()

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

{Add added to amount.

Parameters
string$amount
string$addend
Returns
string
}

Implements Money\Calculator.

Definition at line 33 of file PhpCalculator.php.

◆ ceil()

Money\Calculator\PhpCalculator::ceil (   $number)

{Round number to following integer.

Parameters
string$number
Returns
string
}

Implements Money\Calculator.

Definition at line 81 of file PhpCalculator.php.

Referenced by Money\Calculator\PhpCalculator\round().

◆ compare()

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

{Compare a to b.

Parameters
string$a
string$b
Returns
int
}

Implements Money\Calculator.

Definition at line 25 of file PhpCalculator.php.

◆ divide()

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

{Divide amount with divisor.

Parameters
string$amount
int | float | string$divisor
Returns
string
}

Implements Money\Calculator.

Definition at line 69 of file PhpCalculator.php.

References Money\Number\fromNumber().

◆ floor()

Money\Calculator\PhpCalculator::floor (   $number)

{Round number to preceding integer.

Parameters
string$number
Returns
string
}

Implements Money\Calculator.

Definition at line 89 of file PhpCalculator.php.

Referenced by Money\Calculator\PhpCalculator\round(), and Money\Calculator\PhpCalculator\share().

◆ mod()

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

{Get the modulus of an amount.

Parameters
string$amount
int | float | string$divisor
Returns
string
}

Implements Money\Calculator.

Definition at line 145 of file PhpCalculator.php.

◆ multiply()

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

{Multiply amount with multiplier.

Parameters
string$amount
int | float | string$multiplier
Returns
string
}

Implements Money\Calculator.

Definition at line 57 of file PhpCalculator.php.

References Money\Number\fromNumber().

◆ round()

Money\Calculator\PhpCalculator::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 109 of file PhpCalculator.php.

References Money\Calculator\PhpCalculator\ceil(), Money\Calculator\PhpCalculator\floor(), Money\Number\fromNumber(), Money\Money\ROUND_HALF_DOWN, Money\Money\ROUND_HALF_NEGATIVE_INFINITY, Money\Money\ROUND_HALF_POSITIVE_INFINITY, and Money\Money\ROUND_HALF_UP.

◆ share()

Money\Calculator\PhpCalculator::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 137 of file PhpCalculator.php.

References Money\Calculator\PhpCalculator\floor().

◆ subtract()

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

{Subtract subtrahend from amount.

Parameters
string$amount
string$subtrahend
Returns
string
}

Implements Money\Calculator.

Definition at line 45 of file PhpCalculator.php.

◆ supported()

static Money\Calculator\PhpCalculator::supported ( )
static

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

Returns
bool
}

Implements Money\Calculator.

Definition at line 17 of file PhpCalculator.php.

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