PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Writer/Xls/Worksheet.php

Doc Comments +9 added lines, -7 removed lines

@@ -236,10 +236,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 Worksheet $phpSheet
+     * @param integer $str_total
+     * @param integer $str_unique
      */
     public function __construct(&$str_total, &$str_unique, &$str_table, &$colors, $parser, $preCalculateFormulas, $phpSheet)
     {
@@ -636,7 +638,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
      */
@@ -745,7 +747,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
      */
@@ -812,7 +814,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)
     {
@@ -859,7 +861,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
@@ -2339,8 +2341,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/Cell/Cell.php

Doc Comments +2 added lines, -2 removed lines

@@ -532,7 +532,7 @@ 
     /**
      * Get cell style.
      *
-     * @return Style
+     * @return Style\Style
      */
     public function getStyle()
     {
@@ -947,7 +947,7 @@ 
      *
      *    [ 'A1:A3' => 'x', 'A4' => 'y' ]
      *
-     * @param array $pCoordCollection associative array mapping coordinates to values
+     * @param DataValidation[] $pCoordCollection associative array mapping coordinates to values
      *
      * @return array associative array mapping coordinate ranges to valuea
      */

src/PhpSpreadsheet/Chart/Renderer/JpGraph.php

Doc Comments +63 added lines

@@ -76,6 +76,9 @@ 
         $loaded = true;
     }
 
+    /**
+     * @param string $markerID
+     */
     private function formatPointMarker($seriesPlot, $markerID)
     {
         $plotMarkKeys = array_keys(self::$markSet);
@@ -103,6 +106,9 @@ 
         return $seriesPlot;
     }
 
+    /**
+     * @param integer $labelCount
+     */
     private function formatDataSetLabels($groupID, $datasetLabels, $labelCount, $rotation = '')
     {
         $datasetLabelFormatCode = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotCategoryByIndex(0)->getFormatCode();
@@ -132,6 +138,9 @@ 
         return $datasetLabels;
     }
 
+    /**
+     * @param integer $seriesCount
+     */
     private function percentageSumCalculation($groupID, $seriesCount)
     {
         //    Adjust our values to a percentage value across all series in the group
@@ -162,6 +171,9 @@ 
         return $dataValues;
     }
 
+    /**
+     * @param \PhpOffice\PhpSpreadsheet\Chart\Title $captionElement
+     */
     private function getCaption($captionElement)
     {
         //    Read any caption
@@ -271,6 +283,9 @@ 
         $this->renderTitle();
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotLine($groupID, $filled = false, $combination = false, $dimensions = '2d')
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -334,6 +349,9 @@ 
         $this->graph->Add($groupPlot);
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotBar($groupID, $dimensions = '2d')
     {
         $rotation = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotDirection();
@@ -418,6 +436,10 @@ 
         $this->graph->Add($groupPlot);
     }
 
+    /**
+     * @param integer $groupID
+     * @param boolean $bubble
+     */
     private function renderPlotScatter($groupID, $bubble)
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -463,6 +485,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotRadar($groupID)
     {
         $radarStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -501,6 +526,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotContour($groupID)
     {
         $contourStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -521,6 +549,9 @@ 
         $this->graph->Add($seriesPlot);
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotStock($groupID)
     {
         $seriesCount = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotSeriesCount();
@@ -560,6 +591,9 @@ 
         $this->graph->Add($seriesPlot);
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderAreaChart($groupCount, $dimensions = '2d')
     {
         $this->renderCartesianPlotArea();
@@ -569,6 +603,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderLineChart($groupCount, $dimensions = '2d')
     {
         $this->renderCartesianPlotArea();
@@ -578,6 +615,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBarChart($groupCount, $dimensions = '2d')
     {
         $this->renderCartesianPlotArea();
@@ -587,6 +627,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderScatterChart($groupCount)
     {
         $this->renderCartesianPlotArea('linlin');
@@ -596,6 +639,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBubbleChart($groupCount)
     {
         $this->renderCartesianPlotArea('linlin');
@@ -605,6 +651,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderPieChart($groupCount, $dimensions = '2d', $doughnut = false, $multiplePlots = false)
     {
         $this->renderPiePlotArea();
@@ -676,6 +725,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderRadarChart($groupCount)
     {
         $this->renderRadarPlotArea();
@@ -685,6 +737,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderStockChart($groupCount)
     {
         $this->renderCartesianPlotArea('intint');
@@ -694,6 +749,10 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     * @param string|null $dimensions
+     */
     private function renderContourChart($groupCount, $dimensions)
     {
         $this->renderCartesianPlotArea('intint');
@@ -703,6 +762,10 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     * @param string $outputDestination
+     */
     private function renderCombinationChart($groupCount, $dimensions, $outputDestination)
     {
         $this->renderCartesianPlotArea();

src/PhpSpreadsheet/Worksheet/Worksheet.php

Doc Comments +6 added lines, -6 removed lines

@@ -576,7 +576,7 @@ 
      *
      * @throws Exception
      *
-     * @return Chart|false
+     * @return Chart
      */
     public function getChartByIndex($index)
     {
@@ -1087,7 +1087,7 @@ 
      * @param string $column Return the highest data row for the specified column,
      *                                     or the highest data row of any column if no column letter is passed
      *
-     * @return string Highest row number that contains data
+     * @return integer Highest row number that contains data
      */
     public function getHighestDataRow($column = null)
     {
@@ -1139,7 +1139,7 @@ 
      * Set a cell value.
      *
      * @param string $pCoordinate Coordinate of the cell, eg: 'A1'
-     * @param mixed $pValue Value of the cell
+     * @param string $pValue Value of the cell
      * @param string $pDataType Explicit data type, see DataType::TYPE_*
      *
      * @return Worksheet
@@ -1343,7 +1343,7 @@ 
      * Get row dimension at a specific row.
      *
      * @param int $pRow Numeric index of the row
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return RowDimension
      */
@@ -1369,7 +1369,7 @@ 
      * Get column dimension at a specific column.
      *
      * @param string $pColumn String index of the column eg: 'A'
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return ColumnDimension
      */
@@ -1910,7 +1910,7 @@ 
     /**
      * Set AutoFilter.
      *
-     * @param string|Worksheet\AutoFilter $pValue
+     * @param string $pValue
      *            A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
      *
      * @throws Exception

src/PhpSpreadsheet/Writer/Html.php

Doc Comments +1 added lines, -1 removed lines

@@ -1164,7 +1164,7 @@
      * @param Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet
      * @param array $pValues Array containing cells in a row
      * @param int $pRow Row number (0-based)
-     * @param mixed $cellType eg: 'td'
+     * @param string $cellType eg: 'td'
      *
      * @throws WriterException
      *

src/PhpSpreadsheet/Writer/Ods/MetaInf.php

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace PhpOffice\PhpSpreadsheet\Writer\Ods;
 
 use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
-use PhpOffice\PhpSpreadsheet\Spreadsheet;
 
 class MetaInf extends WriterPart
 {

src/PhpSpreadsheet/Writer/Xls/Workbook.php

Doc Comments +3 added lines, -3 removed lines

@@ -224,8 +224,8 @@ 
      *
      * @param Style
      * @param bool Is it a style XF?
-     * @param mixed $style
-     * @param mixed $isStyleXf
+     * @param Style $style
+     * @param boolean $isStyleXf
      *
      * @return int Index to XF record
      */
@@ -683,7 +683,7 @@ 
      *
      * @param string $name The name in UTF-8
      * @param string $formulaData The binary formula data
-     * @param string $sheetIndex 1-based sheet index the defined name applies to. 0 = global
+     * @param integer $sheetIndex 1-based sheet index the defined name applies to. 0 = global
      * @param bool $isBuiltIn Built-in name?
      *
      * @return string Complete binary record data

src/PhpSpreadsheet/Writer/Xlsx/Chart.php

Doc Comments +5 added lines, -5 removed lines

@@ -204,7 +204,7 @@ 
      * Write Chart Plot Area.
      *
      * @param XMLWriter $objWriter XML Writer
-     * @param Worksheet $pSheet
+     * @param \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pSheet
      * @param PlotArea $plotArea
      * @param Title $xAxisLabel
      * @param Title $yAxisLabel
@@ -394,7 +394,7 @@ 
      * @param string $id1
      * @param string $id2
      * @param bool $isMultiLevelSeries
-     * @param mixed $yAxis
+     * @param null|Axis $yAxis
      *
      * @throws WriterException
      */
@@ -515,9 +515,9 @@ 
      * @param string $id1
      * @param string $id2
      * @param bool $isMultiLevelSeries
-     * @param mixed $xAxis
-     * @param mixed $majorGridlines
-     * @param mixed $minorGridlines
+     * @param null|Axis $xAxis
+     * @param null|GridLines $majorGridlines
+     * @param null|GridLines $minorGridlines
      *
      * @throws WriterException
      */

src/PhpSpreadsheet/Writer/Xlsx/Comments.php

Doc Comments +2 added lines, -2 removed lines

@@ -11,7 +11,7 @@ 
     /**
      * Write comments to XML format.
      *
-     * @param Worksheet $pWorksheet
+     * @param \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pWorksheet
      *
      * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
      *
@@ -94,7 +94,7 @@ 
     /**
      * Write VML comments to XML format.
      *
-     * @param Worksheet $pWorksheet
+     * @param \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $pWorksheet
      *
      * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
      *