PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Worksheet/RowDimension.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
     /**
      * Set Row Height
      *
-     * @param float $pValue
+     * @param integer $pValue
      * @return RowDimension
      */
     public function setRowHeight($pValue = -1)

src/PhpSpreadsheet/Shared/OLE.php

Spacing +1 added lines, -1 removed lines

@@ -266,7 +266,7 @@
     public function _readPpsWks($blockId)
     {
         $fh = $this->getStream($blockId);
-        for ($pos = 0;; $pos += 128) {
+        for ($pos = 0; ; $pos += 128) {
             fseek($fh, $pos, SEEK_SET);
             $nameUtf16 = fread($fh, 64);
             $nameLength = self::_readInt2($fh);

src/PhpSpreadsheet/Style/Fill.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
     /**
      * Set Row Height
      *
-     * @param float $pValue
+     * @param integer $pValue
      * @return RowDimension
      */
     public function setRowHeight($pValue = -1)

src/PhpSpreadsheet/Style/Font.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
     /**
      * Set Row Height
      *
-     * @param float $pValue
+     * @param integer $pValue
      * @return RowDimension
      */
     public function setRowHeight($pValue = -1)

src/PhpSpreadsheet/Calculation.php

Doc Comments +19 added lines, -2 removed lines

@@ -2076,7 +2076,6 @@ 
     /**
      * Unset an instance of this class
      *
-     * @param   Spreadsheet $spreadsheet  Injected spreadsheet identifying the instance to unset
      */
     public function __destruct()
     {
@@ -2328,6 +2327,10 @@ 
         return false;
     }
 
+    /**
+     * @param string $fromSeparator
+     * @param string $toSeparator
+     */
     public static function translateSeparator($fromSeparator, $toSeparator, $formula, &$inBraces)
     {
         $strlen = mb_strlen($formula);
@@ -2658,6 +2661,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $cellReference
+     */
     public function getValueFromCache($cellReference, &$cellValue)
     {
         // Is calculation cacheing enabled?
@@ -2797,7 +2803,7 @@ 
      * Read the dimensions of a matrix, and re-index it with straight numeric keys starting from row 0, column 0
      *
      * @param    mixed        &$matrix        matrix operand
-     * @return    int[]        An array comprising the number of rows, and number of columns
+     * @return    integer[]        An array comprising the number of rows, and number of columns
      */
     private static function getMatrixDimensions(&$matrix)
     {
@@ -2981,6 +2987,9 @@ 
         }
     }
 
+    /**
+     * @param string $formula
+     */
     private function convertMatrixReferences($formula)
     {
         static $matrixReplaceFrom = ['{', ';', '}'];
@@ -3069,6 +3078,10 @@ 
     ];
 
     // Convert infix to postfix notation
+
+    /**
+     * @param string $formula
+     */
     private function _parseFormula($formula, Cell $pCell = null)
     {
         if (($formula = $this->convertMatrixReferences(trim($formula))) === false) {
@@ -3891,6 +3904,9 @@ 
         return true;
     }
 
+    /**
+     * @param string|null $cellID
+     */
     private function executeBinaryComparisonOperation($cellID, $operand1, $operand2, $operation, &$stack, $recursingArrays = false)
     {
         //    If we're dealing with matrix operations, we want a matrix result
@@ -4029,6 +4045,7 @@ 
 
     /**
      * @param string $matrixFunction
+     * @param string|null $cellID
      */
     private function executeNumericBinaryOperation($cellID, $operand1, $operand2, $operation, $matrixFunction, &$stack)
     {

src/PhpSpreadsheet/Calculation/DateTime.php

Doc Comments +16 added lines, -16 removed lines

@@ -460,7 +460,7 @@ 
      *        DATEVALUE(dateValue)
      *
      * @category Date/Time Functions
-     * @param    string    $dateValue        Text that represents a date in a Microsoft Excel date format.
+     * @param    integer    $dateValue        Text that represents a date in a Microsoft Excel date format.
      *                                    For example, "1/30/2008" or "30-Jan-2008" are text strings within
      *                                    quotation marks that represent dates. Using the default date
      *                                    system in Excel for Windows, date_text must represent a date from
@@ -644,9 +644,9 @@ 
     /**
      * DATEDIF
      *
-     * @param    mixed    $startDate        Excel date serial value, PHP date/time stamp, PHP DateTime object
+     * @param    integer    $startDate        Excel date serial value, PHP date/time stamp, PHP DateTime object
      *                                    or a standard date string
-     * @param    mixed    $endDate        Excel date serial value, PHP date/time stamp, PHP DateTime object
+     * @param    integer    $endDate        Excel date serial value, PHP date/time stamp, PHP DateTime object
      *                                    or a standard date string
      * @param    string    $unit
      * @return    int    Interval between the dates
@@ -757,9 +757,9 @@ 
      *        DAYS360(startDate,endDate[,method])
      *
      * @category Date/Time Functions
-     * @param    mixed        $startDate        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer        $startDate        Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
-     * @param    mixed        $endDate        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer        $endDate        Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
      * @param    bool        $method            US or European Method
      *                                        FALSE or omitted: U.S. (NASD) method. If the starting date is
@@ -816,9 +816,9 @@ 
      *        YEARFRAC(startDate,endDate[,method])
      *
      * @category Date/Time Functions
-     * @param    mixed    $startDate        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $startDate        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
-     * @param    mixed    $endDate        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $endDate        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @param    int    $method            Method used for the calculation
      *                                        0 or omitted    US (NASD) 30/360
@@ -1102,7 +1102,7 @@ 
      * Excel Function:
      *        DAY(dateValue)
      *
-     * @param    mixed    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @return    int        Day of the month
      */
@@ -1211,7 +1211,7 @@ 
      * Excel Function:
      *        WEEKNUM(dateValue[,style])
      *
-     * @param    mixed    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @param    int    $method            Week begins on Sunday or Monday
      *                                        1 or omitted    Week begins on Sunday.
@@ -1259,7 +1259,7 @@ 
      * Excel Function:
      *        MONTH(dateValue)
      *
-     * @param    mixed    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @return    int        Month of the year
      */
@@ -1291,7 +1291,7 @@ 
      * Excel Function:
      *        YEAR(dateValue)
      *
-     * @param    mixed    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @return    int        Year
      */
@@ -1322,7 +1322,7 @@ 
      * Excel Function:
      *        HOUR(timeValue)
      *
-     * @param    mixed    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard time string
      * @return    int        Hour
      */
@@ -1362,7 +1362,7 @@ 
      * Excel Function:
      *        MINUTE(timeValue)
      *
-     * @param    mixed    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard time string
      * @return    int        Minute
      */
@@ -1402,7 +1402,7 @@ 
      * Excel Function:
      *        SECOND(timeValue)
      *
-     * @param    mixed    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard time string
      * @return    int        Second
      */
@@ -1444,7 +1444,7 @@ 
      * Excel Function:
      *        EDATE(dateValue,adjustmentMonths)
      *
-     * @param    mixed    $dateValue            Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue            Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
      * @param    int        $adjustmentMonths    The number of months before or after start_date.
      *                                        A positive value for months yields a future date;
@@ -1489,7 +1489,7 @@ 
      * Excel Function:
      *        EOMONTH(dateValue,adjustmentMonths)
      *
-     * @param    mixed    $dateValue            Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue            Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
      * @param    int        $adjustmentMonths    The number of months before or after start_date.
      *                                        A positive value for months yields a future date;

src/PhpSpreadsheet/Calculation/Financial.php

Doc Comments +27 added lines, -17 removed lines

@@ -58,6 +58,10 @@ 
         return $testDate->format('d') == 1;
     }
 
+    /**
+     * @param integer $frequency
+     * @param boolean $next
+     */
     private static function couponFirstPeriodDate($settlement, $maturity, $frequency, $next)
     {
         $months = 12 / $frequency;
@@ -79,6 +83,9 @@ 
         return \PhpSpreadsheet\Shared\Date::PHPToExcel($result);
     }
 
+    /**
+     * @param integer $frequency
+     */
     private static function isValidFrequency($frequency)
     {
         if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) {
@@ -155,7 +162,7 @@ 
      *                                    The security settlement date is the date after the issue date
      *                                    when the security is traded to the buyer.
      * @param    float    $rate            The security's annual coupon rate.
-     * @param    float    $par            The security's par value.
+     * @param    integer    $par            The security's par value.
      *                                    If you omit par, ACCRINT uses $1,000.
      * @param    int    $frequency        the number of coupon payments per year.
      *                                    Valid frequency values are:
@@ -421,6 +428,7 @@ 
      *                                        2                Actual/360
      *                                        3                Actual/365
      *                                        4                European 30/360
+     * @param integer $frequency
      * @return    float
      */
     public static function COUPDAYBS($settlement, $maturity, $frequency, $basis = 0)
@@ -553,6 +561,7 @@ 
      *                                        2                Actual/360
      *                                        3                Actual/365
      *                                        4                European 30/360
+     * @param integer $frequency
      * @return    float
      */
     public static function COUPDAYSNC($settlement, $maturity, $frequency, $basis = 0)
@@ -666,6 +675,7 @@ 
      *                                        2                Actual/360
      *                                        3                Actual/365
      *                                        4                European 30/360
+     * @param integer $frequency
      * @return    int
      */
     public static function COUPNUM($settlement, $maturity, $frequency, $basis = 0)
@@ -1119,7 +1129,7 @@ 
      *        EFFECT(nominal_rate,npery)
      *
      * @category Financial Functions
-     * @param    float    $nominal_rate        Nominal interest rate
+     * @param    integer    $nominal_rate        Nominal interest rate
      * @param    int    $npery                Number of compounding payments per year
      * @return    float
      */
@@ -1145,12 +1155,12 @@ 
      *        FV(rate,nper,pmt[,pv[,type]])
      *
      * @category Financial Functions
-     * @param    float    $rate    The interest rate per period
+     * @param    integer    $rate    The interest rate per period
      * @param    int        $nper    Total number of payment periods in an annuity
-     * @param    float    $pmt    The payment made each period: it cannot change over the
+     * @param    integer    $pmt    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.
-     * @param    float    $pv        Present Value, or the lump-sum amount that a series of
+     * @param    integer    $pv        Present Value, or the lump-sum amount that a series of
      *                            future payments is worth right now.
      * @param    int    $type    A number 0 or 1 and indicates when payments are due:
      *                                0 or omitted    At the end of the period.
@@ -1265,7 +1275,7 @@ 
      * @param    int        $per    Period for which we want to find the interest
      * @param    int        $nper    Number of periods
      * @param    float    $pv        Present Value
-     * @param    float    $fv        Future Value
+     * @param    integer    $fv        Future Value
      * @param    int        $type    Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      * @return    float
      */
@@ -1457,7 +1467,7 @@ 
      *
      * Returns the nominal interest rate given the effective rate and the number of compounding payments per year.
      *
-     * @param    float    $effect_rate    Effective interest rate
+     * @param    integer    $effect_rate    Effective interest rate
      * @param    int        $npery            Number of compounding payments per year
      * @return    float
      */
@@ -1480,10 +1490,10 @@ 
      *
      * Returns the number of periods for a cash flow with constant periodic payments (annuities), and interest rate.
      *
-     * @param    float    $rate    Interest rate per period
+     * @param    integer    $rate    Interest rate per period
      * @param    int        $pmt    Periodic payment (annuity)
-     * @param    float    $pv        Present Value
-     * @param    float    $fv        Future Value
+     * @param    integer    $pv        Present Value
+     * @param    integer    $fv        Future Value
      * @param    int        $type    Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      * @return    float
      */
@@ -1548,10 +1558,10 @@ 
      *
      * Returns the constant payment (annuity) for a cash flow with a constant interest rate.
      *
-     * @param    float    $rate    Interest rate per period
+     * @param    integer    $rate    Interest rate per period
      * @param    int        $nper    Number of periods
-     * @param    float    $pv        Present Value
-     * @param    float    $fv        Future Value
+     * @param    integer    $pv        Present Value
+     * @param    integer    $fv        Future Value
      * @param    int        $type    Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      * @return    float
      */
@@ -1585,7 +1595,7 @@ 
      * @param    int        $per    Period for which we want to find the interest
      * @param    int        $nper    Number of periods
      * @param    float    $pv        Present Value
-     * @param    float    $fv        Future Value
+     * @param    integer    $fv        Future Value
      * @param    int        $type    Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      * @return    float
      */
@@ -1767,10 +1777,10 @@ 
      *
      * Returns the Present Value of a cash flow with constant payments and interest rate (annuities).
      *
-     * @param    float    $rate    Interest rate per period
+     * @param    integer    $rate    Interest rate per period
      * @param    int        $nper    Number of periods
-     * @param    float    $pmt    Periodic payment (annuity)
-     * @param    float    $fv        Future Value
+     * @param    integer    $pmt    Periodic payment (annuity)
+     * @param    integer    $fv        Future Value
      * @param    int        $type    Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      * @return    float
      */

src/PhpSpreadsheet/Calculation/FormulaParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
      *
      * @param     int        $pId    Token id
      * @throws  Exception
-     * @return    string
+     * @return    FormulaToken
      */
     public function getToken($pId = 0)
     {

src/PhpSpreadsheet/Calculation/Logical.php

Doc Comments +2 added lines, -4 removed lines

@@ -75,7 +75,6 @@ 
      *            the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
      *
      * @category Logical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    string|bool        The logical AND of the arguments.
      */
     public static function logicalAnd()
@@ -130,7 +129,6 @@ 
      *            the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
      *
      * @category Logical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    string|bool        The logical OR of the arguments.
      */
     public static function logicalOr()
@@ -230,8 +228,8 @@ 
      *            ReturnIfFalse can be another formula.
      *
      * @category Logical Functions
-     * @param    mixed    $condition        Condition to evaluate
-     * @param    mixed    $returnIfTrue    Value to return when condition is true
+     * @param    boolean    $condition        Condition to evaluate
+     * @param    integer    $returnIfTrue    Value to return when condition is true
      * @param    mixed    $returnIfFalse    Optional value to return when condition is false
      * @return    mixed    The value of returnIfTrue or returnIfFalse determined by condition
      */