Documentation

Price
in package

Table of Contents

Methods

price()  : float|string
PRICE.
priceAtMaturity()  : float|string
PRICEMAT.
priceDiscounted()  : float|string
PRICEDISC.
received()  : float|string
RECEIVED.

Methods

price()

PRICE.

public static price(mixed $settlement, mixed $maturity, mixed $rate, mixed $yield, mixed $redemption, mixed $frequency[, mixed $basis = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD ]) : float|string

Returns the price per $100 face value of a security that pays periodic interest.

Parameters
$settlement : mixed

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

$maturity : mixed

The security's maturity date. The maturity date is the date when the security expires.

$rate : mixed

the security's annual coupon rate

$yield : mixed

the security's annual yield

$redemption : mixed

The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.

$frequency : mixed
$basis : mixed = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD

The type of day count to use. 0 or omitted US (NASD) 30/360 1 Actual/actual 2 Actual/360 3 Actual/365 4 European 30/360

Return values
float|string

Result, or a string containing an error

priceAtMaturity()

PRICEMAT.

public static priceAtMaturity(mixed $settlement, mixed $maturity, mixed $issue, mixed $rate, mixed $yield[, mixed $basis = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD ]) : float|string

Returns the price per $100 face value of a security that pays interest at maturity.

Parameters
$settlement : mixed

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.

$maturity : mixed

The security's maturity date. The maturity date is the date when the security expires.

$issue : mixed

The security's issue date

$rate : mixed

The security's interest rate at date of issue

$yield : mixed

The security's annual yield

$basis : mixed = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD

The type of day count to use. 0 or omitted US (NASD) 30/360 1 Actual/actual 2 Actual/360 3 Actual/365 4 European 30/360

Return values
float|string

Result, or a string containing an error

priceDiscounted()

PRICEDISC.

public static priceDiscounted(mixed $settlement, mixed $maturity, mixed $discount, mixed $redemption[, mixed $basis = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD ]) : float|string

Returns the price per $100 face value of a discounted security.

Parameters
$settlement : mixed

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

$maturity : mixed

The security's maturity date. The maturity date is the date when the security expires.

$discount : mixed

The security's discount rate

$redemption : mixed

The security's redemption value per $100 face value

$basis : mixed = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD

The type of day count to use. 0 or omitted US (NASD) 30/360 1 Actual/actual 2 Actual/360 3 Actual/365 4 European 30/360

Return values
float|string

Result, or a string containing an error

received()

RECEIVED.

public static received(mixed $settlement, mixed $maturity, mixed $investment, mixed $discount[, mixed $basis = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD ]) : float|string

Returns the amount received at maturity for a fully invested Security.

Parameters
$settlement : mixed

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

$maturity : mixed

The security's maturity date. The maturity date is the date when the security expires.

$investment : mixed

The amount invested in the security

$discount : mixed

The security's discount rate

$basis : mixed = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD

The type of day count to use. 0 or omitted US (NASD) 30/360 1 Actual/actual 2 Actual/360 3 Actual/365 4 European 30/360

Return values
float|string

Result, or a string containing an error


        
On this page

Search results