Periodic
in package
Table of Contents
Methods
- futureValue() : string|float
- FV.
- periods() : float|string
- NPER.
- presentValue() : float|string
- PV.
- calculateFutureValue() : float
- calculatePeriods() : string|float
- calculatePresentValue() : float
Methods
futureValue()
FV.
public
static futureValue(mixed $rate, mixed $numberOfPeriods[, mixed $payment = 0.0 ][, mixed $presentValue = 0.0 ][, mixed $type = FinancialConstants::PAYMENT_END_OF_PERIOD ]) : string|float
Returns the Future Value of a cash flow with constant payments and interest rate (annuities).
Excel Function: FV(rate,nper,pmt[,pv[,type]])
Parameters
- $rate : mixed
-
The interest rate per period
- $numberOfPeriods : mixed
-
Total number of payment periods in an annuity as an integer
- $payment : mixed = 0.0
-
The payment made each period: it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes.
- $presentValue : mixed = 0.0
-
present Value, or the lump-sum amount that a series of future payments is worth right now
- $type : mixed = FinancialConstants::PAYMENT_END_OF_PERIOD
-
A number 0 or 1 and indicates when payments are due: 0 or omitted At the end of the period. 1 At the beginning of the period.
Return values
string|floatperiods()
NPER.
public
static periods(mixed $rate, mixed $payment, mixed $presentValue[, mixed $futureValue = 0.0 ][, mixed $type = FinancialConstants::PAYMENT_END_OF_PERIOD ]) : float|string
Returns the number of periods for a cash flow with constant periodic payments (annuities), and interest rate.
Parameters
- $rate : mixed
-
Interest rate per period
- $payment : mixed
-
Periodic payment (annuity)
- $presentValue : mixed
-
Present Value
- $futureValue : mixed = 0.0
-
Future Value
- $type : mixed = FinancialConstants::PAYMENT_END_OF_PERIOD
-
Payment type: 0 = at the end of each period, 1 = at the beginning of each period
Return values
float|string —Result, or a string containing an error
presentValue()
PV.
public
static presentValue(mixed $rate, mixed $numberOfPeriods[, mixed $payment = 0.0 ][, mixed $futureValue = 0.0 ][, mixed $type = FinancialConstants::PAYMENT_END_OF_PERIOD ]) : float|string
Returns the Present Value of a cash flow with constant payments and interest rate (annuities).
Parameters
- $rate : mixed
-
Interest rate per period
- $numberOfPeriods : mixed
-
Number of periods as an integer
- $payment : mixed = 0.0
-
Periodic payment (annuity)
- $futureValue : mixed = 0.0
-
Future Value
- $type : mixed = FinancialConstants::PAYMENT_END_OF_PERIOD
-
Payment type: 0 = at the end of each period, 1 = at the beginning of each period
Return values
float|string —Result, or a string containing an error
calculateFutureValue()
private
static calculateFutureValue(float $rate, int $numberOfPeriods, float $payment, float $presentValue, int $type) : float
Parameters
- $rate : float
- $numberOfPeriods : int
- $payment : float
- $presentValue : float
- $type : int
Return values
floatcalculatePeriods()
private
static calculatePeriods(float $rate, float $payment, float $presentValue, float $futureValue, int $type) : string|float
Parameters
- $rate : float
- $payment : float
- $presentValue : float
- $futureValue : float
- $type : int
Return values
string|floatcalculatePresentValue()
private
static calculatePresentValue(float $rate, int $numberOfPeriods, float $payment, float $futureValue, int $type) : float
Parameters
- $rate : float
- $numberOfPeriods : int
- $payment : float
- $futureValue : float
- $type : int