|
@@ -27,9 +27,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* ACCRINT(issue,firstinterest,settlement,rate,par,frequency[,basis][,calc_method])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
+ * @see Financial\Securities\AccruedInterest::periodic()
|
|
|
* Use the periodic() method in the Financial\Securities\AccruedInterest class instead
|
|
|
- * @see Securities\AccruedInterest::periodic()
|
|
|
*
|
|
|
* @param mixed $issue the security's issue date
|
|
|
* @param mixed $firstInterest the security's first interest date
|
|
@@ -86,9 +87,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* ACCRINTM(issue,settlement,rate[,par[,basis]])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the atMaturity() method in the Financial\Securities\AccruedInterest class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Securities\AccruedInterest::atMaturity()
|
|
|
+ * Use the atMaturity() method in the Financial\Securities\AccruedInterest class instead
|
|
|
*
|
|
|
* @param mixed $issue The security's issue date
|
|
|
* @param mixed $settlement The security's settlement (or maturity) date
|
|
@@ -124,9 +126,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* AMORDEGRC(cost,purchased,firstPeriod,salvage,period,rate[,basis])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the AMORDEGRC() method in the Financial\Amortization class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Amortization::AMORDEGRC()
|
|
|
+ * Use the AMORDEGRC() method in the Financial\Amortization class instead
|
|
|
*
|
|
|
* @param float $cost The cost of the asset
|
|
|
* @param mixed $purchased Date of the purchase of the asset
|
|
@@ -158,9 +161,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* AMORLINC(cost,purchased,firstPeriod,salvage,period,rate[,basis])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the AMORLINC() method in the Financial\Amortization class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Amortization::AMORLINC()
|
|
|
+ * Use the AMORLINC() method in the Financial\Amortization class instead
|
|
|
*
|
|
|
* @param float $cost The cost of the asset
|
|
|
* @param mixed $purchased Date of the purchase of the asset
|
|
@@ -190,9 +194,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* COUPDAYBS(settlement,maturity,frequency[,basis])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the COUPDAYBS() method in the Financial\Coupons class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Coupons::COUPDAYBS()
|
|
|
+ * Use the COUPDAYBS() method in the Financial\Coupons class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue
|
|
@@ -226,9 +231,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* COUPDAYS(settlement,maturity,frequency[,basis])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the COUPDAYS() method in the Financial\Coupons class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Coupons::COUPDAYS()
|
|
|
+ * Use the COUPDAYS() method in the Financial\Coupons class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue
|
|
@@ -262,9 +268,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* COUPDAYSNC(settlement,maturity,frequency[,basis])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the COUPDAYSNC() method in the Financial\Coupons class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Coupons::COUPDAYSNC()
|
|
|
+ * Use the COUPDAYSNC() method in the Financial\Coupons class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue
|
|
@@ -298,9 +305,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* COUPNCD(settlement,maturity,frequency[,basis])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the COUPNCD() method in the Financial\Coupons class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Coupons::COUPNCD()
|
|
|
+ * Use the COUPNCD() method in the Financial\Coupons class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue
|
|
@@ -336,9 +344,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* COUPNUM(settlement,maturity,frequency[,basis])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the COUPNUM() method in the Financial\Coupons class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Coupons::COUPNUM()
|
|
|
+ * Use the COUPNUM() method in the Financial\Coupons class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue
|
|
@@ -372,9 +381,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* COUPPCD(settlement,maturity,frequency[,basis])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the COUPPCD() method in the Financial\Coupons class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Coupons::COUPPCD()
|
|
|
+ * Use the COUPPCD() method in the Financial\Coupons class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue
|
|
@@ -409,9 +419,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* CUMIPMT(rate,nper,pv,start,end[,type])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the interest() method in the Financial\CashFlow\Constant\Periodic\Cumulative class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Constant\Periodic\Cumulative::interest()
|
|
|
+ * Use the interest() method in the Financial\CashFlow\Constant\Periodic\Cumulative class instead
|
|
|
*
|
|
|
* @param float $rate The Interest rate
|
|
|
* @param int $nper The total number of payment periods
|
|
@@ -438,9 +449,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* CUMPRINC(rate,nper,pv,start,end[,type])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the principal() method in the Financial\CashFlow\Constant\Periodic\Cumulative class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Constant\Periodic\Cumulative::principal()
|
|
|
+ * Use the principal() method in the Financial\CashFlow\Constant\Periodic\Cumulative class instead
|
|
|
*
|
|
|
* @param float $rate The Interest rate
|
|
|
* @param int $nper The total number of payment periods
|
|
@@ -472,9 +484,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* DB(cost,salvage,life,period[,month])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the DB() method in the Financial\Depreciation class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Depreciation::DB()
|
|
|
+ * Use the DB() method in the Financial\Depreciation class instead
|
|
|
*
|
|
|
* @param float $cost Initial cost of the asset
|
|
|
* @param float $salvage Value at the end of the depreciation.
|
|
@@ -502,9 +515,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* DDB(cost,salvage,life,period[,factor])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the DDB() method in the Financial\Depreciation class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Depreciation::DDB()
|
|
|
+ * Use the DDB() method in the Financial\Depreciation class instead
|
|
|
*
|
|
|
* @param float $cost Initial cost of the asset
|
|
|
* @param float $salvage Value at the end of the depreciation.
|
|
@@ -532,16 +546,17 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* DISC(settlement,maturity,price,redemption[,basis])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the discount() method in the Financial\Securities\Rates class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Securities\Rates::discount()
|
|
|
+ * Use the discount() method in the Financial\Securities\Rates class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue
|
|
|
* date when the security is traded to the buyer.
|
|
|
* @param mixed $maturity The security's maturity date.
|
|
|
* The maturity date is the date when the security expires.
|
|
|
- * @param mixed $price The security's price per $100 face value
|
|
|
+ * @param int $price The security's price per $100 face value
|
|
|
* @param int $redemption The security's redemption value per $100 face value
|
|
|
* @param int $basis The type of day count to use.
|
|
|
* 0 or omitted US (NASD) 30/360
|
|
@@ -567,9 +582,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* DOLLARDE(fractional_dollar,fraction)
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the decimal() method in the Financial\Dollar class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Dollar::decimal()
|
|
|
+ * Use the decimal() method in the Financial\Dollar class instead
|
|
|
*
|
|
|
* @param array|float $fractional_dollar Fractional Dollar
|
|
|
* @param array|int $fraction Fraction
|
|
@@ -591,9 +607,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* DOLLARFR(decimal_dollar,fraction)
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the fractional() method in the Financial\Dollar class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Dollar::fractional()
|
|
|
+ * Use the fractional() method in the Financial\Dollar class instead
|
|
|
*
|
|
|
* @param array|float $decimal_dollar Decimal Dollar
|
|
|
* @param array|int $fraction Fraction
|
|
@@ -614,9 +631,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* EFFECT(nominal_rate,npery)
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the effective() method in the Financial\InterestRate class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\InterestRate::effective()
|
|
|
+ * Use the effective() method in the Financial\InterestRate class instead
|
|
|
*
|
|
|
* @param float $nominalRate Nominal interest rate
|
|
|
* @param int $periodsPerYear Number of compounding payments per year
|
|
@@ -636,9 +654,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* FV(rate,nper,pmt[,pv[,type]])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the futureValue() method in the Financial\CashFlow\Constant\Periodic class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Constant\Periodic::futureValue()
|
|
|
+ * Use the futureValue() method in the Financial\CashFlow\Constant\Periodic class instead
|
|
|
*
|
|
|
* @param float $rate The interest rate per period
|
|
|
* @param int $nper Total number of payment periods in an annuity
|
|
@@ -667,9 +686,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* FVSCHEDULE(principal,schedule)
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the futureValue() method in the Financial\CashFlow\Single class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Single::futureValue()
|
|
|
+ * Use the futureValue() method in the Financial\CashFlow\Single class instead
|
|
|
*
|
|
|
* @param float $principal the present value
|
|
|
* @param float[] $schedule an array of interest rates to apply
|
|
@@ -689,9 +709,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* INTRATE(settlement,maturity,investment,redemption[,basis])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the interest() method in the Financial\Securities\Rates class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Securities\Rates::interest()
|
|
|
+ * Use the interest() method in the Financial\Securities\Rates class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue date when the security
|
|
@@ -723,9 +744,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* IPMT(rate,per,nper,pv[,fv][,type])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the payment() method in the Financial\CashFlow\Constant\Periodic\Interest class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Constant\Periodic\Interest::payment()
|
|
|
+ * Use the payment() method in the Financial\CashFlow\Constant\Periodic class instead
|
|
|
*
|
|
|
* @param float $rate Interest rate per period
|
|
|
* @param int $per Period for which we want to find the interest
|
|
@@ -753,9 +775,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* IRR(values[,guess])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the rate() method in the Financial\CashFlow\Variable\Periodic class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Variable\Periodic::rate()
|
|
|
+ * Use the rate() method in the Financial\CashFlow\Variable\Periodic class instead
|
|
|
*
|
|
|
* @param mixed $values An array or a reference to cells that contain numbers for which you want
|
|
|
* to calculate the internal rate of return.
|
|
@@ -778,9 +801,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* =ISPMT(interest_rate, period, number_payments, pv)
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the schedulePayment() method in the Financial\CashFlow\Constant\Periodic\Interest class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Constant\Periodic\Interest::schedulePayment()
|
|
|
+ * Use the schedulePayment() method in the Financial\CashFlow\Constant\Periodic class instead
|
|
|
*
|
|
|
* interest_rate is the interest rate for the investment
|
|
|
*
|
|
@@ -789,10 +813,6 @@ class Financial
|
|
|
* number_payments is the number of payments for the annuity
|
|
|
*
|
|
|
* pv is the loan amount or present value of the payments
|
|
|
- *
|
|
|
- * @param array $args
|
|
|
- *
|
|
|
- * @return float|string
|
|
|
*/
|
|
|
public static function ISPMT(...$args)
|
|
|
{
|
|
@@ -808,9 +828,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* MIRR(values,finance_rate, reinvestment_rate)
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the modifiedRate() method in the Financial\CashFlow\Variable\Periodic class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Variable\Periodic::modifiedRate()
|
|
|
+ * Use the modifiedRate() method in the Financial\CashFlow\Variable\Periodic class instead
|
|
|
*
|
|
|
* @param mixed $values An array or a reference to cells that contain a series of payments and
|
|
|
* income occurring at regular intervals.
|
|
@@ -833,9 +854,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* NOMINAL(effect_rate, npery)
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the nominal() method in the Financial\InterestRate class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\InterestRate::nominal()
|
|
|
+ * Use the nominal() method in the Financial\InterestRate class instead
|
|
|
*
|
|
|
* @param float $effectiveRate Effective interest rate
|
|
|
* @param int $periodsPerYear Number of compounding payments per year
|
|
@@ -852,9 +874,7 @@ class Financial
|
|
|
*
|
|
|
* Returns the number of periods for a cash flow with constant periodic payments (annuities), and interest rate.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the periods() method in the Financial\CashFlow\Constant\Periodic class instead
|
|
|
- * @see Financial\CashFlow\Constant\Periodic::periods()
|
|
|
+ * @Deprecated 1.18.0
|
|
|
*
|
|
|
* @param float $rate Interest rate per period
|
|
|
* @param int $pmt Periodic payment (annuity)
|
|
@@ -863,6 +883,9 @@ class Financial
|
|
|
* @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
|
|
|
*
|
|
|
* @return float|string Result, or a string containing an error
|
|
|
+ *
|
|
|
+ *@see Financial\CashFlow\Constant\Periodic::periods()
|
|
|
+ * Use the periods() method in the Financial\CashFlow\Constant\Periodic class instead
|
|
|
*/
|
|
|
public static function NPER($rate = 0, $pmt = 0, $pv = 0, $fv = 0, $type = 0)
|
|
|
{
|
|
@@ -874,11 +897,10 @@ class Financial
|
|
|
*
|
|
|
* Returns the Net Present Value of a cash flow series given a discount rate.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the presentValue() method in the Financial\CashFlow\Variable\Periodic class instead
|
|
|
- * @see Financial\CashFlow\Variable\Periodic::presentValue()
|
|
|
+ * @Deprecated 1.18.0
|
|
|
*
|
|
|
- * @param array $args
|
|
|
+ * @see Financial\CashFlow\Variable\Periodic::presentValue()
|
|
|
+ * Use the presentValue() method in the Financial\CashFlow\Variable\Periodic class instead
|
|
|
*
|
|
|
* @return float
|
|
|
*/
|
|
@@ -892,9 +914,10 @@ class Financial
|
|
|
*
|
|
|
* Calculates the number of periods required for an investment to reach a specified value.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the periods() method in the Financial\CashFlow\Single class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Single::periods()
|
|
|
+ * Use the periods() method in the Financial\CashFlow\Single class instead
|
|
|
*
|
|
|
* @param float $rate Interest rate per period
|
|
|
* @param float $pv Present Value
|
|
@@ -912,9 +935,10 @@ class Financial
|
|
|
*
|
|
|
* Returns the constant payment (annuity) for a cash flow with a constant interest rate.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the annuity() method in the Financial\CashFlow\Constant\Periodic\Payments class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Constant\Periodic\Payments::annuity()
|
|
|
+ * Use the annuity() method in the Financial\CashFlow\Constant\Periodic\Payments class instead
|
|
|
*
|
|
|
* @param float $rate Interest rate per period
|
|
|
* @param int $nper Number of periods
|
|
@@ -935,9 +959,10 @@ class Financial
|
|
|
* Returns the interest payment for a given period for an investment based on periodic, constant payments
|
|
|
* and a constant interest rate.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the interestPayment() method in the Financial\CashFlow\Constant\Periodic\Payments class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Constant\Periodic\Payments::interestPayment()
|
|
|
+ * Use the interestPayment() method in the Financial\CashFlow\Constant\Periodic\Payments class instead
|
|
|
*
|
|
|
* @param float $rate Interest rate per period
|
|
|
* @param int $per Period for which we want to find the interest
|
|
@@ -958,9 +983,10 @@ class Financial
|
|
|
*
|
|
|
* Returns the price per $100 face value of a security that pays periodic interest.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the price() method in the Financial\Securities\Price class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Securities\Price::price()
|
|
|
+ * Use the price() method in the Financial\Securities\Price class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue date when the security
|
|
@@ -993,16 +1019,17 @@ class Financial
|
|
|
*
|
|
|
* Returns the price per $100 face value of a discounted security.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the priceDiscounted() method in the Financial\Securities\Price class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Securities\Price::priceDiscounted()
|
|
|
+ * Use the priceDiscounted() method in the Financial\Securities\Price class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue date when the security
|
|
|
* is traded to the buyer.
|
|
|
* @param mixed $maturity The security's maturity date.
|
|
|
* The maturity date is the date when the security expires.
|
|
|
- * @param mixed $discount The security's discount rate
|
|
|
+ * @param int $discount The security's discount rate
|
|
|
* @param int $redemption The security's redemption value per $100 face value
|
|
|
* @param int $basis The type of day count to use.
|
|
|
* 0 or omitted US (NASD) 30/360
|
|
@@ -1023,9 +1050,10 @@ class Financial
|
|
|
*
|
|
|
* Returns the price per $100 face value of a security that pays interest at maturity.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the priceAtMaturity() method in the Financial\Securities\Price class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Securities\Price::priceAtMaturity()
|
|
|
+ * Use the priceAtMaturity() method in the Financial\Securities\Price class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security's settlement date is the date after the issue date when the security
|
|
@@ -1033,8 +1061,8 @@ class Financial
|
|
|
* @param mixed $maturity The security's maturity date.
|
|
|
* The maturity date is the date when the security expires.
|
|
|
* @param mixed $issue The security's issue date
|
|
|
- * @param mixed $rate The security's interest rate at date of issue
|
|
|
- * @param mixed $yield The security's annual yield
|
|
|
+ * @param int $rate The security's interest rate at date of issue
|
|
|
+ * @param int $yield The security's annual yield
|
|
|
* @param int $basis The type of day count to use.
|
|
|
* 0 or omitted US (NASD) 30/360
|
|
|
* 1 Actual/actual
|
|
@@ -1054,9 +1082,10 @@ class Financial
|
|
|
*
|
|
|
* Returns the Present Value of a cash flow with constant payments and interest rate (annuities).
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the presentValue() method in the Financial\CashFlow\Constant\Periodic class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Constant\Periodic::presentValue()
|
|
|
+ * Use the presentValue() method in the Financial\CashFlow\Constant\Periodic class instead
|
|
|
*
|
|
|
* @param float $rate Interest rate per period
|
|
|
* @param int $nper Number of periods
|
|
@@ -1082,9 +1111,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* RATE(nper,pmt,pv[,fv[,type[,guess]]])
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the rate() method in the Financial\CashFlow\Constant\Periodic\Interest class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Constant\Periodic\Interest::rate()
|
|
|
+ * Use the rate() method in the Financial\CashFlow\Constant\Periodic class instead
|
|
|
*
|
|
|
* @param mixed $nper The total number of payment periods in an annuity
|
|
|
* @param mixed $pmt The payment made each period and cannot change over the life
|
|
@@ -1114,9 +1144,10 @@ class Financial
|
|
|
*
|
|
|
* Returns the amount received at maturity for a fully invested Security.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the received() method in the Financial\Securities\Price class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Securities\Price::received()
|
|
|
+ * Use the received() method in the Financial\Securities\Price class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security settlement date is the date after the issue date when the security
|
|
@@ -1144,9 +1175,10 @@ class Financial
|
|
|
*
|
|
|
* Calculates the interest rate required for an investment to grow to a specified future value .
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the interestRate() method in the Financial\CashFlow\Single class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Single::interestRate()
|
|
|
+ * Use the interestRate() method in the Financial\CashFlow\Single class instead
|
|
|
*
|
|
|
* @param float $nper The number of periods over which the investment is made
|
|
|
* @param float $pv Present Value
|
|
@@ -1164,9 +1196,10 @@ class Financial
|
|
|
*
|
|
|
* Returns the straight-line depreciation of an asset for one period
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the SLN() method in the Financial\Depreciation class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Depreciation::SLN()
|
|
|
+ * Use the SLN() method in the Financial\Depreciation class instead
|
|
|
*
|
|
|
* @param mixed $cost Initial cost of the asset
|
|
|
* @param mixed $salvage Value at the end of the depreciation
|
|
@@ -1184,9 +1217,10 @@ class Financial
|
|
|
*
|
|
|
* Returns the sum-of-years' digits depreciation of an asset for a specified period.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the SYD() method in the Financial\Depreciation class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Depreciation::SYD()
|
|
|
+ * Use the SYD() method in the Financial\Depreciation class instead
|
|
|
*
|
|
|
* @param mixed $cost Initial cost of the asset
|
|
|
* @param mixed $salvage Value at the end of the depreciation
|
|
@@ -1205,16 +1239,17 @@ class Financial
|
|
|
*
|
|
|
* Returns the bond-equivalent yield for a Treasury bill.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the bondEquivalentYield() method in the Financial\TreasuryBill class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\TreasuryBill::bondEquivalentYield()
|
|
|
+ * Use the bondEquivalentYield() method in the Financial\TreasuryBill class instead
|
|
|
*
|
|
|
* @param mixed $settlement The Treasury bill's settlement date.
|
|
|
* The Treasury bill's settlement date is the date after the issue date when the
|
|
|
* Treasury bill is traded to the buyer.
|
|
|
* @param mixed $maturity The Treasury bill's maturity date.
|
|
|
* The maturity date is the date when the Treasury bill expires.
|
|
|
- * @param mixed $discount The Treasury bill's discount rate
|
|
|
+ * @param int $discount The Treasury bill's discount rate
|
|
|
*
|
|
|
* @return float|string Result, or a string containing an error
|
|
|
*/
|
|
@@ -1228,16 +1263,17 @@ class Financial
|
|
|
*
|
|
|
* Returns the price per $100 face value for a Treasury bill.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the price() method in the Financial\TreasuryBill class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\TreasuryBill::price()
|
|
|
+ * Use the price() method in the Financial\TreasuryBill class instead
|
|
|
*
|
|
|
* @param mixed $settlement The Treasury bill's settlement date.
|
|
|
* The Treasury bill's settlement date is the date after the issue date
|
|
|
* when the Treasury bill is traded to the buyer.
|
|
|
* @param mixed $maturity The Treasury bill's maturity date.
|
|
|
* The maturity date is the date when the Treasury bill expires.
|
|
|
- * @param mixed $discount The Treasury bill's discount rate
|
|
|
+ * @param int $discount The Treasury bill's discount rate
|
|
|
*
|
|
|
* @return float|string Result, or a string containing an error
|
|
|
*/
|
|
@@ -1251,16 +1287,17 @@ class Financial
|
|
|
*
|
|
|
* Returns the yield for a Treasury bill.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the yield() method in the Financial\TreasuryBill class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\TreasuryBill::yield()
|
|
|
+ * Use the yield() method in the Financial\TreasuryBill class instead
|
|
|
*
|
|
|
* @param mixed $settlement The Treasury bill's settlement date.
|
|
|
* The Treasury bill's settlement date is the date after the issue date
|
|
|
* when the Treasury bill is traded to the buyer.
|
|
|
* @param mixed $maturity The Treasury bill's maturity date.
|
|
|
* The maturity date is the date when the Treasury bill expires.
|
|
|
- * @param mixed $price The Treasury bill's price per $100 face value
|
|
|
+ * @param int $price The Treasury bill's price per $100 face value
|
|
|
*
|
|
|
* @return float|mixed|string
|
|
|
*/
|
|
@@ -1277,9 +1314,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* =XIRR(values,dates,guess)
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the rate() method in the Financial\CashFlow\Variable\NonPeriodic class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Variable\NonPeriodic::rate()
|
|
|
+ * Use the rate() method in the Financial\CashFlow\Variable\NonPeriodic class instead
|
|
|
*
|
|
|
* @param float[] $values A series of cash flow payments
|
|
|
* The series of values must contain at least one positive value & one negative value
|
|
@@ -1304,9 +1342,10 @@ class Financial
|
|
|
* Excel Function:
|
|
|
* =XNPV(rate,values,dates)
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the presentValue() method in the Financial\CashFlow\Variable\NonPeriodic class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\CashFlow\Variable\NonPeriodic::presentValue()
|
|
|
+ * Use the presentValue() method in the Financial\CashFlow\Variable\NonPeriodic class instead
|
|
|
*
|
|
|
* @param float $rate the discount rate to apply to the cash flows
|
|
|
* @param float[] $values A series of cash flows that corresponds to a schedule of payments in dates.
|
|
@@ -1331,16 +1370,17 @@ class Financial
|
|
|
*
|
|
|
* Returns the annual yield of a security that pays interest at maturity.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the yieldDiscounted() method in the Financial\Securities\Yields class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Securities\Yields::yieldDiscounted()
|
|
|
+ * Use the yieldDiscounted() method in the Financial\Securities\Yields class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security's settlement date is the date after the issue date when the security
|
|
|
* is traded to the buyer.
|
|
|
* @param mixed $maturity The security's maturity date.
|
|
|
* The maturity date is the date when the security expires.
|
|
|
- * @param mixed $price The security's price per $100 face value
|
|
|
+ * @param int $price The security's price per $100 face value
|
|
|
* @param int $redemption The security's redemption value per $100 face value
|
|
|
* @param int $basis The type of day count to use.
|
|
|
* 0 or omitted US (NASD) 30/360
|
|
@@ -1361,9 +1401,10 @@ class Financial
|
|
|
*
|
|
|
* Returns the annual yield of a security that pays interest at maturity.
|
|
|
*
|
|
|
- * @deprecated 1.18.0
|
|
|
- * Use the yieldAtMaturity() method in the Financial\Securities\Yields class instead
|
|
|
+ * @Deprecated 1.18.0
|
|
|
+ *
|
|
|
* @see Financial\Securities\Yields::yieldAtMaturity()
|
|
|
+ * Use the yieldAtMaturity() method in the Financial\Securities\Yields class instead
|
|
|
*
|
|
|
* @param mixed $settlement The security's settlement date.
|
|
|
* The security's settlement date is the date after the issue date when the security
|
|
@@ -1371,8 +1412,8 @@ class Financial
|
|
|
* @param mixed $maturity The security's maturity date.
|
|
|
* The maturity date is the date when the security expires.
|
|
|
* @param mixed $issue The security's issue date
|
|
|
- * @param mixed $rate The security's interest rate at date of issue
|
|
|
- * @param mixed $price The security's price per $100 face value
|
|
|
+ * @param int $rate The security's interest rate at date of issue
|
|
|
+ * @param int $price The security's price per $100 face value
|
|
|
* @param int $basis The type of day count to use.
|
|
|
* 0 or omitted US (NASD) 30/360
|
|
|
* 1 Actual/actual
|