PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Shared/Font.php

Doc Comments +1 added lines, -1 removed lines

@@ -235,7 +235,7 @@
      * Calculate an (approximate) OpenXML column width, based on font size and text contained
      *
      * @param     \PhpOffice\PhpSpreadsheet\Style\Font            $font            Font object
-     * @param     \PhpOffice\PhpSpreadsheet\RichText|string    $cellText        Text to calculate width
+     * @param     string    $cellText        Text to calculate width
      * @param     int                        $rotation        Rotation angle
      * @param     \PhpOffice\PhpSpreadsheet\Style\Font|null    $defaultFont    Font object
      * @return     int        Column width

src/PhpSpreadsheet/Reader/Xlsx/Chart.php

Doc Comments +3 added lines

@@ -204,6 +204,9 @@
         return $chart;
     }
 
+    /**
+     * @param string $type
+     */
     private static function chartTitle($titleDetails, $namespacesChartMeta, $type)
     {
         $caption = [];

src/PhpSpreadsheet/Reader/Xls.php

Doc Comments +5 added lines, -5 removed lines

@@ -5157,7 +5157,7 @@ 
      * is in one piece.
      * Moves to next current position in data stream to start of next record different from a CONtINUE record
      *
-     * @return array
+     * @return integer|null
      */
     private function getSplicedRecordData()
     {
@@ -5421,7 +5421,7 @@ 
      * @param string $formulaData Formula data
      * @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
      * @throws Exception
-     * @return array
+     * @return string
      */
     private function getNextToken($formulaData, $baseCell = 'A1')
     {
@@ -6989,7 +6989,7 @@ 
      * section 2.5.15
      *
      * @param string $subData
-     * @return array
+     * @return string
      */
     private function readBIFF8CellRangeAddressList($subData)
     {
@@ -7100,7 +7100,7 @@ 
      * section 2.5.8
      *
      * @param string $arrayData
-     * @return array
+     * @return string
      */
     private static function readBIFF8ConstantArray($arrayData)
     {
@@ -7138,7 +7138,7 @@ 
      * returns e.g. array('value' => '5', 'size' => 9)
      *
      * @param string $valueData
-     * @return array
+     * @return string
      */
     private static function readBIFF8Constant($valueData)
     {

src/PhpSpreadsheet/Reader/Xls/MD5.php

Doc Comments +5 added lines

@@ -190,6 +190,11 @@
         return ($Y ^ ($X | (~ $Z))) ; // Y XOR (X OR NOT Z)
     }
 
+    /**
+     * @param string[] $func
+     * @param integer $s
+     * @param integer $t
+     */
     private static function step($func, &$A, $B, $C, $D, $M, $s, $t)
     {
         $A = ($A + call_user_func($func, $B, $C, $D) + $M + $t) & 0xffffffff;

src/PhpSpreadsheet/Writer/Xls/Worksheet.php

Doc Comments +9 added lines, -7 removed lines

@@ -199,10 +199,12 @@ 
      * @param int        &$str_unique    Total number of unique strings
      * @param array        &$str_table        String Table
      * @param array        &$colors        Colour Table
-     * @param mixed        $parser            The formula parser created for the Workbook
+     * @param Parser        $parser            The formula parser created for the Workbook
      * @param bool    $preCalculateFormulas    Flag indicating whether formulas should be calculated or just written
      * @param string    $phpSheet        The worksheet to write
      * @param \PhpSpreadsheet\Worksheet $phpSheet
+     * @param integer $str_total
+     * @param integer $str_unique
      */
     public function __construct(&$str_total, &$str_unique, &$str_table, &$colors, $parser, $preCalculateFormulas, $phpSheet)
     {
@@ -611,7 +613,7 @@ 
      * @param int $row    Zero indexed row
      * @param int $col    Zero indexed column
      * @param float   $num    The number to write
-     * @param mixed   $xfIndex The optional XF format
+     * @param integer   $xfIndex The optional XF format
      * @return int
      */
     private function writeNumber($row, $col, $num, $xfIndex)
@@ -717,7 +719,7 @@ 
      * @param int $row    Zero indexed row
      * @param int $col    Zero indexed column
      * @param string  $str    The string to write
-     * @param mixed   $xfIndex The XF format index for the cell
+     * @param integer   $xfIndex The XF format index for the cell
      * @return int
      */
     private function writeLabelSst($row, $col, $str, $xfIndex)
@@ -783,7 +785,7 @@ 
      *
      * @param int $row    Zero indexed row
      * @param int $col    Zero indexed column
-     * @param mixed   $xfIndex The XF format index
+     * @param integer   $xfIndex The XF format index
      */
     public function writeBlank($row, $col, $xfIndex)
     {
@@ -830,7 +832,7 @@ 
      * @param int $row     Zero indexed row
      * @param int $col     Zero indexed column
      * @param string  $formula The formula text string
-     * @param mixed   $xfIndex  The XF format index
+     * @param integer   $xfIndex  The XF format index
      * @param mixed   $calculatedValue  Calculated value
      * @return int
      */
@@ -2299,8 +2301,8 @@ 
      * @param mixed   $bitmap  The bitmap filename or GD-image resource
      * @param int $x       The horizontal position (offset) of the image inside the cell.
      * @param int $y       The vertical position (offset) of the image inside the cell.
-     * @param float   $scale_x The horizontal scale
-     * @param float   $scale_y The vertical scale
+     * @param integer   $scale_x The horizontal scale
+     * @param integer   $scale_y The vertical scale
      */
     public function insertBitmap($row, $col, $bitmap, $x = 0, $y = 0, $scale_x = 1, $scale_y = 1)
     {

src/PhpSpreadsheet/Shared/JAMA/Matrix.php

Doc Comments +2 added lines, -47 removed lines

@@ -149,12 +149,6 @@ 
      *
      *    Get a submatrix
      *
-     *    @param int $i0 Initial row index
-     *    @param int $iF Final row index
-     *    @param int $j0 Initial column index
-     *    @param int $jF Final column index
-     *
-     *    @return Matrix Submatrix
      */
     public function getMatrix()
     {
@@ -365,7 +359,7 @@ 
      *
      *    @param int $m Row dimension
      *    @param int $n Column dimension
-     *    @param mixed $c Diagonal value
+     *    @param integer $c Diagonal value
      *
      *    @return Matrix Diagonal matrix
      */
@@ -449,7 +443,7 @@ 
      *
      *    Sum of diagonal elements
      *
-     *    @return float Sum of diagonal elements
+     *    @return integer Sum of diagonal elements
      */
     public function trace()
     {
@@ -478,9 +472,6 @@ 
      *
      *    A + B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function plus()
     {
@@ -521,9 +512,6 @@ 
      *
      *    A = A + B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function plusEquals()
     {
@@ -578,9 +566,6 @@ 
      *
      *    A - B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function minus()
     {
@@ -621,9 +606,6 @@ 
      *
      *    A = A - B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function minusEquals()
     {
@@ -679,9 +661,6 @@ 
      *    Element-by-element multiplication
      *    Cij = Aij * Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Cij
      */
     public function arrayTimes()
     {
@@ -723,9 +702,6 @@ 
      *    Element-by-element multiplication
      *    Aij = Aij * Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Aij
      */
     public function arrayTimesEquals()
     {
@@ -781,9 +757,6 @@ 
      *    Element-by-element right division
      *    A / B
      *
-     *    @param Matrix $B Matrix B
-     *
-     *    @return Matrix Division result
      */
     public function arrayRightDivide()
     {
@@ -844,9 +817,6 @@ 
      *    Element-by-element right division
      *    Aij = Aij / Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Aij
      */
     public function arrayRightDivideEquals()
     {
@@ -888,9 +858,6 @@ 
      *    Element-by-element Left division
      *    A / B
      *
-     *    @param Matrix $B Matrix B
-     *
-     *    @return Matrix Division result
      */
     public function arrayLeftDivide()
     {
@@ -932,9 +899,6 @@ 
      *    Element-by-element Left division
      *    Aij = Aij / Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Aij
      */
     public function arrayLeftDivideEquals()
     {
@@ -975,9 +939,6 @@ 
      *
      *    Matrix multiplication
      *
-     *    @param mixed $n Matrix/Array/Scalar
-     *
-     *    @return Matrix Product
      */
     public function times()
     {
@@ -1078,9 +1039,6 @@ 
      *
      *    A = A ^ B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function power()
     {
@@ -1135,9 +1093,6 @@ 
      *
      *    A = A & B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function concat()
     {

src/PhpSpreadsheet/Shared/OLERead.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
     /**
      * Read the file
      *
-     * @param $pFilename string Filename
+     * @param string $pFilename string Filename
      * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception
      */
     public function read($pFilename)

src/PhpSpreadsheet/Calculation.php

Doc Comments +19 added lines, -3 removed lines

@@ -2072,7 +2072,6 @@ 
     /**
      * Unset an instance of this class.
      *
-     * @param   Spreadsheet $spreadsheet  Injected spreadsheet identifying the instance to unset
      */
     public function __destruct()
     {
@@ -2326,6 +2325,10 @@ 
         return false;
     }
 
+    /**
+     * @param string $fromSeparator
+     * @param string $toSeparator
+     */
     public static function translateSeparator($fromSeparator, $toSeparator, $formula, &$inBraces)
     {
         $strlen = mb_strlen($formula);
@@ -2669,6 +2672,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $cellReference
+     */
     public function getValueFromCache($cellReference, &$cellValue)
     {
         // Is calculation cacheing enabled?
@@ -2812,7 +2818,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)
     {
@@ -2997,6 +3003,9 @@ 
         }
     }
 
+    /**
+     * @param string $formula
+     */
     private function convertMatrixReferences($formula)
     {
         static $matrixReplaceFrom = ['{', ';', '}'];
@@ -3085,6 +3094,10 @@ 
     ];
 
     // Convert infix to postfix notation
+
+    /**
+     * @param string $formula
+     */
     private function _parseFormula($formula, Cell $pCell = null)
     {
         if (($formula = $this->convertMatrixReferences(trim($formula))) === false) {
@@ -3820,6 +3833,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
@@ -3960,7 +3976,7 @@ 
 
     /**
      * @param string $matrixFunction
-     * @param mixed $cellID
+     * @param string|null $cellID
      * @param mixed $operand1
      * @param mixed $operand2
      * @param mixed $operation

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
      */