PHPOffice / PhpSpreadsheet

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/Shared/Drawing.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
      *
      * @param int $pValue Value in pixels
      *
-     * @return int Value in EMU
+     * @return double Value in EMU
      */
     public static function pixelsToEMU($pValue = 0)
     {

src/PhpSpreadsheet/Shared/ZipArchive.php

Doc Comments +1 added lines, -1 removed lines

@@ -387,7 +387,7 @@
     /**
      * Get Contiguous
      *
-     * @return bool
+     * @return integer
      */
     public function getContiguous()
     {

src/PhpSpreadsheet/Calculation.php

Doc Comments +19 added lines, -3 removed lines

@@ -2075,7 +2075,6 @@ 
     /**
      * Unset an instance of this class.
      *
-     * @param Spreadsheet $spreadsheet Injected spreadsheet identifying the instance to unset
      */
     public function __destruct()
     {
@@ -2329,6 +2328,10 @@ 
         return false;
     }
 
+    /**
+     * @param string $fromSeparator
+     * @param string $toSeparator
+     */
     public static function translateSeparator($fromSeparator, $toSeparator, $formula, &$inBraces)
     {
         $strlen = mb_strlen($formula);
@@ -2672,6 +2675,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $cellReference
+     */
     public function getValueFromCache($cellReference, &$cellValue)
     {
         // Is calculation cacheing enabled?
@@ -2815,7 +2821,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)
     {
@@ -3000,6 +3006,9 @@ 
         }
     }
 
+    /**
+     * @param string $formula
+     */
     private function convertMatrixReferences($formula)
     {
         static $matrixReplaceFrom = ['{', ';', '}'];
@@ -3088,6 +3097,10 @@ 
     ];
 
     // Convert infix to postfix notation
+
+    /**
+     * @param string $formula
+     */
     private function _parseFormula($formula, Cell $pCell = null)
     {
         if (($formula = $this->convertMatrixReferences(trim($formula))) === false) {
@@ -3824,6 +3837,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
@@ -3964,7 +3980,7 @@ 
 
     /**
      * @param string $matrixFunction
-     * @param mixed $cellID
+     * @param string|null $cellID
      * @param mixed $operand1
      * @param mixed $operand2
      * @param mixed $operation

src/PhpSpreadsheet/Calculation/DateTime.php

Doc Comments +16 added lines, -16 removed lines

@@ -471,7 +471,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
@@ -657,9 +657,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
      *
@@ -783,9 +783,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
@@ -844,9 +844,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
@@ -1135,7 +1135,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
@@ -1246,7 +1246,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.
@@ -1299,7 +1299,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
@@ -1332,7 +1332,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
@@ -1364,7 +1364,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
@@ -1405,7 +1405,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
@@ -1446,7 +1446,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
@@ -1489,7 +1489,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;
@@ -1535,7 +1535,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

@@ -1853,7 +1853,7 @@ 
      *
      * @param string $complexNumber the complex number for which you want the real coefficient
      *
-     * @return float
+     * @return string
      */
     public static function IMREAL($complexNumber)
     {
@@ -2291,7 +2291,6 @@ 
      * Excel Function:
      *        IMSUM(complexNumber[,complexNumber[,...]])
      *
-     * @param string $complexNumber,... Series of complex numbers to add
      *
      * @return string
      */
@@ -2331,7 +2330,6 @@ 
      * Excel Function:
      *        IMPRODUCT(complexNumber[,complexNumber[,...]])
      *
-     * @param string $complexNumber,... Series of complex numbers to multiply
      *
      * @return string
      */
@@ -2375,7 +2373,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
      */
@@ -2398,7 +2396,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 +48 added lines, -41 removed lines

@@ -60,6 +60,10 @@ 
         return $testDate->format('d') == 1;
     }
 
+    /**
+     * @param integer $frequency
+     * @param boolean $next
+     */
     private static function couponFirstPeriodDate($settlement, $maturity, $frequency, $next)
     {
         $months = 12 / $frequency;
@@ -81,6 +85,9 @@ 
         return \PhpOffice\PhpSpreadsheet\Shared\Date::PHPToExcel($result);
     }
 
+    /**
+     * @param integer $frequency
+     */
     private static function isValidFrequency($frequency)
     {
         if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) {
@@ -159,7 +166,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:
@@ -232,8 +239,8 @@ 
      * @param mixed $issue
      * @param mixed $settlement
      * @param mixed $rate
-     * @param mixed $par
-     * @param mixed $basis
+     * @param integer $par
+     * @param integer $basis
      *
      * @return float
      */
@@ -299,7 +306,7 @@ 
      * @param mixed $salvage
      * @param mixed $period
      * @param mixed $rate
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -384,7 +391,7 @@ 
      * @param mixed $salvage
      * @param mixed $period
      * @param mixed $rate
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -454,8 +461,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return float
      */
@@ -518,7 +525,7 @@ 
      * @param int $frequency
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -597,8 +604,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return float
      */
@@ -661,7 +668,7 @@ 
      * @param mixed $settlement
      * @param mixed $maturity
      * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
@@ -722,8 +729,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return int
      */
@@ -799,7 +806,7 @@ 
      * @param mixed $settlement
      * @param mixed $maturity
      * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
@@ -951,7 +958,7 @@ 
      * @param mixed $salvage
      * @param mixed $life
      * @param mixed $period
-     * @param mixed $month
+     * @param integer $month
      *
      * @return float
      */
@@ -1026,7 +1033,7 @@ 
      * @param mixed $salvage
      * @param mixed $life
      * @param mixed $period
-     * @param mixed $factor
+     * @param double $factor
      *
      * @return float
      */
@@ -1095,7 +1102,7 @@ 
      * @param mixed $maturity
      * @param mixed $price
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1214,7 +1221,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
@@ -1242,12 +1249,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.
@@ -1365,7 +1372,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
@@ -1560,7 +1567,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
@@ -1584,10 +1591,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
@@ -1653,10 +1660,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
@@ -1691,7 +1698,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
@@ -1781,7 +1788,7 @@ 
      * @param mixed $maturity
      * @param mixed $discount
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1833,7 +1840,7 @@ 
      * @param mixed $issue
      * @param mixed $rate
      * @param mixed $yield
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1887,10 +1894,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
@@ -1947,9 +1954,9 @@ 
      * @param mixed $nper
      * @param mixed $pmt
      * @param mixed $pv
-     * @param mixed $fv
-     * @param mixed $type
-     * @param mixed $guess
+     * @param double $fv
+     * @param integer $type
+     * @param double $guess
      *
      * @return float
      **/
@@ -2018,7 +2025,7 @@ 
      * @param mixed $maturity
      * @param mixed $investment
      * @param mixed $discount
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -2388,7 +2395,7 @@ 
      * @param mixed $maturity
      * @param mixed $price
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -2445,7 +2452,7 @@ 
      * @param mixed $issue
      * @param mixed $rate
      * @param mixed $price
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */

src/PhpSpreadsheet/Calculation/Logical.php

Doc Comments +2 added lines, -4 removed lines

@@ -78,7 +78,6 @@ 
      *
      * @category Logical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return string|bool the logical AND of the arguments
      */
@@ -135,7 +134,6 @@ 
      *
      * @category Logical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return string|bool the logical OR of the arguments
      */
@@ -239,8 +237,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 +11 added lines, -11 removed lines

@@ -36,7 +36,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
@@ -47,7 +47,7 @@ 
      * @param sheetText Optional Name of worksheet to use
      * @param mixed $row
      * @param mixed $column
-     * @param mixed $relativity
+     * @param integer $relativity
      * @param mixed $referenceStyle
      * @param mixed $sheetText
      *
@@ -361,7 +361,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).
@@ -373,8 +373,8 @@ 
      * @param height The height, in number of rows, that you want the returned reference to be. Height must be a positive number.
      * @param width The width, in number of columns, that you want the returned reference to be. Width must be a positive number.
      * @param null|mixed $cellAddress
-     * @param mixed $rows
-     * @param mixed $columns
+     * @param integer $rows
+     * @param integer $columns
      * @param null|mixed $height
      * @param null|mixed $width
      *
@@ -504,10 +504,10 @@ 
      *
      * @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.
      * @param mixed $lookup_value
      * @param mixed $lookup_array
-     * @param mixed $match_type
+     * @param integer $match_type
      *
      * @return int The relative position of the found item
      */
@@ -604,8 +604,8 @@ 
      * @param row_num The row in array from which to return a value. If row_num is omitted, column_num is required.
      * @param column_num The column in array from which to return a value. If column_num is omitted, row_num is required.
      * @param mixed $arrayValues
-     * @param mixed $rowNum
-     * @param mixed $columnNum
+     * @param integer $rowNum
+     * @param integer $columnNum
      *
      * @return mixed the value of a specified cell or array of cells
      */
@@ -701,11 +701,11 @@ 
      *
      * @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
      * @param mixed $lookup_value
      * @param mixed $lookup_array
-     * @param mixed $index_number
+     * @param integer $index_number
      * @param mixed $not_exact_match
      *
      * @return mixed The value of the found cell