PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Reader/HTML.php

Doc Comments +13 added lines

@@ -168,16 +168,25 @@ 
         return fread($this->fileHandle, $blockSize);
     }
 
+    /**
+     * @param string $data
+     */
     private static function startsWithTag($data)
     {
         return '<' === substr(trim($data), 0, 1);
     }
 
+    /**
+     * @param string $data
+     */
     private static function endsWithTag($data)
     {
         return '>' === substr(trim($data), -1, 1);
     }
 
+    /**
+     * @param string $data
+     */
     private static function containsTags($data)
     {
         return strlen($data) !== strlen(strip_tags($data));
@@ -249,6 +258,10 @@ 
         return array_pop($this->nestedColumn);
     }
 
+    /**
+     * @param \PhpOffice\PhpSpreadsheet\Worksheet $sheet
+     * @param integer $row
+     */
     protected function flushCell($sheet, $column, $row, &$cellContent)
     {
         if (is_string($cellContent)) {

src/PhpSpreadsheet/Calculation.php

Doc Comments +19 added lines, -2 removed lines

@@ -2085,7 +2085,6 @@ 
     /**
      * Unset an instance of this class.
      *
-     * @param Spreadsheet $spreadsheet Injected spreadsheet identifying the instance to unset
      */
     public function __destruct()
     {
@@ -2339,6 +2338,10 @@ 
         return false;
     }
 
+    /**
+     * @param string $fromSeparator
+     * @param string $toSeparator
+     */
     public static function translateSeparator($fromSeparator, $toSeparator, $formula, &$inBraces)
     {
         $strlen = mb_strlen($formula);
@@ -2679,6 +2682,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $cellReference
+     */
     public function getValueFromCache($cellReference, &$cellValue)
     {
         // Is calculation cacheing enabled?
@@ -2821,7 +2827,7 @@ 
      *
      * @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)
     {
@@ -3007,6 +3013,9 @@ 
         }
     }
 
+    /**
+     * @param string $formula
+     */
     private function convertMatrixReferences($formula)
     {
         static $matrixReplaceFrom = ['{', ';', '}'];
@@ -3095,6 +3104,10 @@ 
     ];
 
     // Convert infix to postfix notation
+
+    /**
+     * @param string $formula
+     */
     private function _parseFormula($formula, Cell $pCell = null)
     {
         if (($formula = $this->convertMatrixReferences(trim($formula))) === false) {
@@ -3832,6 +3845,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
@@ -3972,6 +3988,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

@@ -473,7 +473,7 @@ 
      *
      * @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
@@ -660,9 +660,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
      *
@@ -786,9 +786,9 @@ 
      *
      * @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
@@ -847,9 +847,9 @@ 
      *
      * @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
@@ -1138,7 +1138,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
@@ -1249,7 +1249,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.
@@ -1302,7 +1302,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
@@ -1335,7 +1335,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
@@ -1367,7 +1367,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
@@ -1408,7 +1408,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
@@ -1449,7 +1449,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
@@ -1492,7 +1492,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;
@@ -1538,7 +1538,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/Engineering.php

Doc Comments +3 added lines, -5 removed lines

@@ -1855,7 +1855,7 @@ 
      *
      * @param string $complexNumber The complex number for which you want the real coefficient
      *
-     * @return float
+     * @return string
      */
     public static function IMREAL($complexNumber)
     {
@@ -2289,7 +2289,6 @@ 
      * Excel Function:
      *        IMSUM(complexNumber[,complexNumber[,...]])
      *
-     * @param string $complexNumber,... Series of complex numbers to add
      *
      * @return string
      */
@@ -2329,7 +2328,6 @@ 
      * Excel Function:
      *        IMPRODUCT(complexNumber[,complexNumber[,...]])
      *
-     * @param string $complexNumber,... Series of complex numbers to multiply
      *
      * @return string
      */
@@ -2373,7 +2371,7 @@ 
      *        DELTA(a[,b])
      *
      * @param float $a The first number
-     * @param float $b The second number. If omitted, b is assumed to be zero
+     * @param integer $b The second number. If omitted, b is assumed to be zero
      *
      * @return int
      */
@@ -2396,7 +2394,7 @@ 
      *    functions you calculate the count of values that exceed a threshold.
      *
      * @param float $number The value to test against step
-     * @param float $step   The threshold value.
+     * @param integer $step   The threshold value.
      *                      If you omit a value for step, GESTEP uses zero
      *
      * @return int

src/PhpSpreadsheet/Calculation/Financial.php

Doc Comments +27 added lines, -17 removed lines

@@ -62,6 +62,10 @@ 
         return $testDate->format('d') == 1;
     }
 
+    /**
+     * @param integer $frequency
+     * @param boolean $next
+     */
     private static function couponFirstPeriodDate($settlement, $maturity, $frequency, $next)
     {
         $months = 12 / $frequency;
@@ -83,6 +87,9 @@ 
         return \PhpOffice\PhpSpreadsheet\Shared\Date::PHPToExcel($result);
     }
 
+    /**
+     * @param integer $frequency
+     */
     private static function isValidFrequency($frequency)
     {
         if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) {
@@ -161,7 +168,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:
@@ -435,6 +442,7 @@ 
      *                                        2                Actual/360
      *                                        3                Actual/365
      *                                        4                European 30/360
+     * @param integer $frequency
      *
      * @return float
      */
@@ -571,6 +579,7 @@ 
      *                                        2                Actual/360
      *                                        3                Actual/365
      *                                        4                European 30/360
+     * @param integer $frequency
      *
      * @return float
      */
@@ -688,6 +697,7 @@ 
      *                                        2                Actual/360
      *                                        3                Actual/365
      *                                        4                European 30/360
+     * @param integer $frequency
      *
      * @return int
      */
@@ -1159,7 +1169,7 @@ 
      *
      * @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
@@ -1187,12 +1197,12 @@ 
      *
      * @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.
@@ -1310,7 +1320,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
@@ -1505,7 +1515,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
@@ -1529,10 +1539,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
@@ -1598,10 +1608,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
@@ -1636,7 +1646,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
@@ -1821,10 +1831,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

@@ -119,7 +119,7 @@
      *
      * @throws Exception
      *
-     * @return string
+     * @return FormulaToken
      */
     public function getToken($pId = 0)
     {

src/PhpSpreadsheet/Calculation/Logical.php

Doc Comments +2 added lines, -4 removed lines

@@ -80,7 +80,6 @@ 
      *
      * @category Logical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return string|bool The logical AND of the arguments
      */
@@ -137,7 +136,6 @@ 
      *
      * @category Logical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return string|bool The logical OR of the arguments
      */
@@ -241,8 +239,8 @@ 
      *
      * @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

src/PhpSpreadsheet/Calculation/LookupRef.php

Doc Comments +4 added lines, -4 removed lines

@@ -38,7 +38,7 @@ 
      *
      * @param    row                Row number to use in the cell reference
      * @param    column            Column number to use in the cell reference
-     * @param    relativity        Flag indicating the type of reference to return
+     * @param    relativity        integer indicating the type of reference to return
      *                                1 or omitted    Absolute
      *                                2                Absolute row; relative column
      *                                3                Relative row; absolute column
@@ -357,7 +357,7 @@ 
      *
      * @param    cellAddress        The reference from which you want to base the offset. Reference must refer to a cell or
      *                                range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value
-     * @param    rows            The number of rows, up or down, that you want the upper-left cell to refer to.
+     * @param    rows            integer number of rows, up or down, that you want the upper-left cell to refer to.
      *                                Using 5 as the rows argument specifies that the upper-left cell in the reference is
      *                                five rows below reference. Rows can be positive (which means below the starting reference)
      *                                or negative (which means above the starting reference)
@@ -495,7 +495,7 @@ 
      *
      * @param    lookup_value    The value that you want to match in lookup_array
      * @param    lookup_array    The range of cells being searched
-     * @param    match_type        The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered
+     * @param    match_type        integer number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered
      *
      * @return int The relative position of the found item
      */
@@ -688,7 +688,7 @@ 
      *
      * @param    lookup_value    The value that you want to match in lookup_array
      * @param    lookup_array    The range of cells being searched
-     * @param    index_number    The column number in table_array from which the matching value must be returned. The first column is 1
+     * @param    index_number    integer column number in table_array from which the matching value must be returned. The first column is 1
      * @param    not_exact_match    Determines if you are looking for an exact match based on lookup_value
      *
      * @return mixed The value of the found cell

src/PhpSpreadsheet/Calculation/MathTrig.php

Doc Comments +11 added lines, -21 removed lines

@@ -53,6 +53,10 @@ 
         }
     }
 
+    /**
+     * @param integer $num
+     * @param integer $n
+     */
     private static function romanCut($num, $n)
     {
         return ($num - ($num % $n)) / $n;
@@ -344,7 +348,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return int Greatest Common Divisor
      */
@@ -454,7 +457,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return int Lowest Common Multiplier
      */
@@ -506,7 +508,7 @@ 
      * @category Mathematical and Trigonometric Functions
      *
      * @param float $number The positive real number for which you want the logarithm
-     * @param float $base   The base of the logarithm. If base is omitted, it is assumed to be 10
+     * @param integer $base   The base of the logarithm. If base is omitted, it is assumed to be 10
      *
      * @return float
      */
@@ -824,8 +826,8 @@ 
      *
      * Computes x raised to the power y.
      *
-     * @param float $x
-     * @param float $y
+     * @param integer $x
+     * @param integer $y
      *
      * @return float
      */
@@ -857,7 +859,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -897,9 +898,8 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param mixed $arg,... Data values
      *
-     * @return float
+     * @return integer
      */
     public static function QUOTIENT()
     {
@@ -1037,9 +1037,6 @@ 
      *
      * Returns the sum of a power series
      *
-     * @param float $x Input value to the power series
-     * @param float $n Initial power to which you want to raise $x
-     * @param float $m Step by which to increase $n for each term in the series
      * @param    array of mixed        Data Series
      *
      * @return float
@@ -1183,7 +1180,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -1212,10 +1208,9 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param mixed  $arg,...   Data values
      * @param string $condition The criteria that defines which cells will be summed
      *
-     * @return float
+     * @return integer
      */
     public static function SUMIF($aArgs, $condition, $sumArgs = [])
     {
@@ -1254,10 +1249,7 @@ 
      *
      *    @category Mathematical and Trigonometric Functions
      *
-     *    @param    mixed        $arg,...        Data values
-     *    @param    string        $condition        The criteria that defines which cells will be summed
-     *
-     *    @return    float
+     * @return integer
      */
     public static function SUMIFS()
     {
@@ -1302,7 +1294,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -1347,7 +1338,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -1446,7 +1436,7 @@ 
      *
      * Truncates value to the number of fractional digits by number_digits.
      *
-     * @param float $value
+     * @param integer $value
      * @param int   $digits
      *
      * @return float Truncated value