public static function PHPExcel_Calculation_Financial::RECEIVED in Loft Data Grids 6.2

Same name and namespace in other branches

1. 7.2 vendor/phpoffice/phpexcel/Classes/PHPExcel/Calculation/Financial.php \PHPExcel_Calculation_Financial::RECEIVED()

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

Parameters

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 int investment The amount invested in the security. * @param int discount The security's discount rate. * @param int basis 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 float

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Calculation/Financial.php, line 1894

Class

PHPExcel_Calculation_Financial

PHPExcel_Calculation_Financial

Code

public static function RECEIVED($settlement, $maturity, $investment, $discount, $basis = 0) {
  $settlement = PHPExcel_Calculation_Functions::flattenSingleValue($settlement);
  $maturity = PHPExcel_Calculation_Functions::flattenSingleValue($maturity);
  $investment = (double) PHPExcel_Calculation_Functions::flattenSingleValue($investment);
  $discount = (double) PHPExcel_Calculation_Functions::flattenSingleValue($discount);
  $basis = (int) PHPExcel_Calculation_Functions::flattenSingleValue($basis);

  //	Validate
  if (is_numeric($investment) && is_numeric($discount) && is_numeric($basis)) {
    if ($investment <= 0 || $discount <= 0) {
      return PHPExcel_Calculation_Functions::NaN();
    }
    $daysBetweenSettlementAndMaturity = PHPExcel_Calculation_DateTime::YEARFRAC($settlement, $maturity, $basis);
    if (!is_numeric($daysBetweenSettlementAndMaturity)) {

      //	return date error
      return $daysBetweenSettlementAndMaturity;
    }
    return $investment / (1 - $discount * $daysBetweenSettlementAndMaturity);
  }
  return PHPExcel_Calculation_Functions::VALUE();
}