PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Shared/Trend/BestFit.php

Doc Comments +4 added lines

@@ -316,6 +316,10 @@
         return $this->yBestFitValues;
     }
 
+    /**
+     * @param double $sumY2
+     * @param boolean $const
+     */
     protected function calculateGoodnessOfFit($sumX, $sumY, $sumX2, $sumY2, $sumXY, $meanX, $meanY, $const)
     {
         $SSres = $SScov = $SScor = $SStot = $SSsex = 0.0;

src/PhpSpreadsheet/Shared/ZipArchive.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
      * Find if given fileName exist in archive (Emulate ZipArchive locateName())
      *
      * @param        string        $fileName        Filename for the file in zip archive
-     * @return        bool
+     * @return        integer
      */
     public function locateName($fileName)
     {

src/PhpSpreadsheet/Shared/ZipStreamWrapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -166,7 +166,7 @@
      *
      * @param    int        $offset    byte offset
      * @param    int        $whence    SEEK_SET, SEEK_CUR or SEEK_END
-     * @return    bool
+     * @return    boolean|null
      */
     public function stream_seek($offset, $whence) // @codingStandardsIgnoreLine
     {

src/PhpSpreadsheet/Style.php

Doc Comments +1 added lines, -1 removed lines

@@ -147,7 +147,7 @@
     /**
      * Get parent. Only used for style supervisor
      *
-     * @return Spreadsheet
+     * @return Style
      */
     public function getParent()
     {

src/PhpSpreadsheet/Worksheet.php

Doc Comments +8 added lines, -8 removed lines

@@ -584,7 +584,7 @@ 
      *
      * @param string $index Chart index position
      * @throws Exception
-     * @return false|Chart
+     * @return null|Chart
      */
     public function getChartByIndex($index = null)
     {
@@ -1085,7 +1085,7 @@ 
      * Set a cell value
      *
      * @param string $pCoordinate Coordinate of the cell
-     * @param mixed $pValue Value of the cell
+     * @param integer $pValue Value of the cell
      * @param bool $returnCell   Return the worksheet (false, default) or the cell (true)
      * @return Worksheet|Cell    Depending on the last parameter being specified
      */
@@ -1196,8 +1196,8 @@ 
     /**
      * Get cell at a specific coordinate by using numeric cell coordinates
      *
-     * @param  string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param  integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param bool $createIfNotExists  Flag indicating whether a new cell should be created if it doesn't
      *                                       already exist, or a null should be returned instead
      * @return null|Cell Cell that was found/created or null
@@ -1305,8 +1305,8 @@ 
     /**
      * Cell at a specific coordinate by using numeric cell coordinates exists?
      *
-     * @param string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @return bool
      */
     public function cellExistsByColumnAndRow($pColumn = 0, $pRow = 1)
@@ -1923,7 +1923,7 @@ 
     /**
      *    Set AutoFilter
      *
-     *    @param    Worksheet\AutoFilter|string   $pValue
+     *    @param    string   $pValue
      *            A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
      *    @throws Exception
      *    @return Worksheet
@@ -2954,7 +2954,7 @@ 
      *
      * @param null|string Same rule as Title minus space not allowed (but, like Excel, change silently space to underscore)
      * @throws Exception
-     * @return objWorksheet
+     * @return Worksheet
      */
     public function setCodeName($pValue = null)
     {

src/PhpSpreadsheet/Worksheet/AutoFilter.php

Doc Comments +5 added lines

@@ -567,6 +567,11 @@
         return ['method' => 'filterTestInCustomDataSet', 'arguments' => ['filterRules' => $ruleValues, 'join' => AutoFilter\Column::AUTOFILTER_COLUMN_JOIN_AND]];
     }
 
+    /**
+     * @param integer $columnID
+     * @param integer $startRow
+     * @param string $ruleType
+     */
     private function calculateTopTenValue($columnID, $startRow, $endRow, $ruleType, $ruleValue)
     {
         $range = $columnID . $startRow . ':' . $columnID . $endRow;

src/PhpSpreadsheet/Worksheet/ColumnDimension.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/Writer/Excel5/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)
     {

Indentation +8 added lines, -8 removed lines

@@ -1147,14 +1147,14 @@
 
         // Pack the main data stream
         $data = pack('vvvv', $row1, $row2, $col1, $col2) .
-                          $unknown1 .
-                          $link_type .
-                          $unknown2 .
-                          $up_count .
-                          $dir_short_len .
-                          $dir_short .
-                          $unknown3 .
-                          $stream_len; /*.
+                            $unknown1 .
+                            $link_type .
+                            $unknown2 .
+                            $up_count .
+                            $dir_short_len .
+                            $dir_short .
+                            $unknown3 .
+                            $stream_len; /*.
                           $dir_long_len .
                           $unknown4     .
                           $dir_long     .

tests/PhpSpreadsheetTests/Shared/StringTest.php

Spacing +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
     public function testGetCurrencyCode()
     {
         $localeconv = localeconv();
-        $expectedResult = (!empty($localeconv['currency_symbol']) ? $localeconv['currency_symbol'] : (!empty($localeconv['int_curr_symbol']) ? $localeconv['int_curr_symbol']: '$'));
+        $expectedResult = (!empty($localeconv['currency_symbol']) ? $localeconv['currency_symbol'] : (!empty($localeconv['int_curr_symbol']) ? $localeconv['int_curr_symbol'] : '$'));
         $result = call_user_func([StringHelper::class, 'getCurrencyCode']);
         $this->assertEquals($expectedResult, $result);
     }