PHPOffice / PhpSpreadsheet

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/Chart/Renderer/JpGraph.php

Doc Comments +62 added lines

@@ -60,6 +60,9 @@ 
 
     private static $plotMark = 0;
 
+    /**
+     * @param string $markerID
+     */
     private function formatPointMarker($seriesPlot, $markerID)
     {
         $plotMarkKeys = array_keys(self::$markSet);
@@ -87,6 +90,9 @@ 
         return $seriesPlot;
     }
 
+    /**
+     * @param integer $labelCount
+     */
     private function formatDataSetLabels($groupID, $datasetLabels, $labelCount, $rotation = '')
     {
         $datasetLabelFormatCode = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotCategoryByIndex(0)->getFormatCode();
@@ -116,6 +122,9 @@ 
         return $datasetLabels;
     }
 
+    /**
+     * @param integer $seriesCount
+     */
     private function percentageSumCalculation($groupID, $seriesCount)
     {
         //    Adjust our values to a percentage value across all series in the group
@@ -146,6 +155,9 @@ 
         return $dataValues;
     }
 
+    /**
+     * @param \PhpOffice\PhpSpreadsheet\Chart\Title $captionElement
+     */
     private function getCaption($captionElement)
     {
         //    Read any caption
@@ -253,6 +265,9 @@ 
         $this->renderTitle();
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotLine($groupID, $filled = false, $combination = false, $dimensions = '2d')
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -316,6 +331,9 @@ 
         $this->graph->Add($groupPlot);
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotBar($groupID, $dimensions = '2d')
     {
         $rotation = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotDirection();
@@ -400,6 +418,10 @@ 
         $this->graph->Add($groupPlot);
     }
 
+    /**
+     * @param integer $groupID
+     * @param boolean $bubble
+     */
     private function renderPlotScatter($groupID, $bubble)
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -445,6 +467,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotRadar($groupID)
     {
         $radarStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -483,6 +508,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotContour($groupID)
     {
         $contourStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -503,6 +531,9 @@ 
         $this->graph->Add($seriesPlot);
     }
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotStock($groupID)
     {
         $seriesCount = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotSeriesCount();
@@ -542,6 +573,9 @@ 
         $this->graph->Add($seriesPlot);
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderAreaChart($groupCount, $dimensions = '2d')
     {
         require_once \PhpOffice\PhpSpreadsheet\Settings::getChartRendererPath() . 'jpgraph_line.php';
@@ -553,6 +587,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderLineChart($groupCount, $dimensions = '2d')
     {
         require_once \PhpOffice\PhpSpreadsheet\Settings::getChartRendererPath() . 'jpgraph_line.php';
@@ -564,6 +601,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBarChart($groupCount, $dimensions = '2d')
     {
         require_once \PhpOffice\PhpSpreadsheet\Settings::getChartRendererPath() . 'jpgraph_bar.php';
@@ -575,6 +615,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderScatterChart($groupCount)
     {
         require_once \PhpOffice\PhpSpreadsheet\Settings::getChartRendererPath() . 'jpgraph_scatter.php';
@@ -588,6 +631,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBubbleChart($groupCount)
     {
         require_once \PhpOffice\PhpSpreadsheet\Settings::getChartRendererPath() . 'jpgraph_scatter.php';
@@ -599,6 +645,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderPieChart($groupCount, $dimensions = '2d', $doughnut = false, $multiplePlots = false)
     {
         require_once \PhpOffice\PhpSpreadsheet\Settings::getChartRendererPath() . 'jpgraph_pie.php';
@@ -675,6 +724,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderRadarChart($groupCount)
     {
         require_once \PhpOffice\PhpSpreadsheet\Settings::getChartRendererPath() . 'jpgraph_radar.php';
@@ -686,6 +738,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderStockChart($groupCount)
     {
         require_once \PhpOffice\PhpSpreadsheet\Settings::getChartRendererPath() . 'jpgraph_stock.php';
@@ -697,6 +752,10 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     * @param string|null $dimensions
+     */
     private function renderContourChart($groupCount, $dimensions)
     {
         require_once \PhpOffice\PhpSpreadsheet\Settings::getChartRendererPath() . 'jpgraph_contour.php';
@@ -708,6 +767,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderCombinationChart($groupCount, $dimensions, $outputDestination)
     {
         require_once \PhpOffice\PhpSpreadsheet\Settings::getChartRendererPath() . 'jpgraph_line.php';

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.php

Doc Comments +12 added lines, -1 removed lines

@@ -281,6 +281,11 @@ 
         return isset($c->v) ? (string) $c->v : null;
     }
 
+    /**
+     * @param string $r
+     * @param string $cellDataType
+     * @param string $castBaseType
+     */
     private function castToFormula($c, $r, &$cellDataType, &$value, &$calculatedValue, &$sharedFormulas, $castBaseType)
     {
         $cellDataType = 'f';
@@ -335,7 +340,7 @@ 
      *
      * @param     string         $pFilename
      * @throws    Exception
-     * @return    Spreadsheet
+     * @return    \PhpOffice\PhpSpreadsheet\Spreadsheet
      */
     public function load($pFilename)
     {
@@ -2005,6 +2010,9 @@ 
         }
     }
 
+    /**
+     * @param \PhpOffice\PhpSpreadsheet\Style\Border $docBorder
+     */
     private static function readBorder($docBorder, $eleBorder)
     {
         if (isset($eleBorder['style'])) {
@@ -2127,6 +2135,9 @@ 
         return preg_replace('~[^/]+/\.\./~', '', dirname($base) . "/$add");
     }
 
+    /**
+     * @param string $style
+     */
     private static function toCSSArray($style)
     {
         $style = str_replace(["\r", "\n"], '', $style);

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/Writer/Xlsx/Chart.php

Doc Comments +6 added lines

@@ -412,6 +412,8 @@ 
      * @param  string $id1
      * @param  string $id2
      * @param  bool $isMultiLevelSeries
+     * @param null|Axis $xAxis
+     * @param null|Axis $yAxis
      *
      * @throws  \PhpSpreadsheet\Writer\Exception
      */
@@ -534,6 +536,10 @@ 
      * @param  string $id1
      * @param  string $id2
      * @param  bool $isMultiLevelSeries
+     * @param null|Axis $xAxis
+     * @param null|Axis $yAxis
+     * @param null|GridLines $majorGridlines
+     * @param null|GridLines $minorGridlines
      *
      * @throws  \PhpSpreadsheet\Writer\Exception
      */

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/Parser.php

Doc Comments +9 added lines, -9 removed lines

@@ -504,7 +504,7 @@ 
      *
      * @access private
      * @param mixed $token The token to convert.
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convert($token)
     {
@@ -574,7 +574,7 @@ 
      *
      * @access private
      * @param string $string A string for conversion to its ptg value.
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convertString($string)
     {
@@ -654,7 +654,7 @@ 
      *
      * @access private
      * @param string $token An Excel range in the Sheet1!A1:A2 format.
-     * @return mixed The packed ptgArea3d token on success.
+     * @return string The packed ptgArea3d token on success.
      */
     private function convertRange3d($token)
     {
@@ -726,7 +726,7 @@ 
      *
      * @access private
      * @param string $cell An Excel cell reference
-     * @return mixed The packed ptgRef3d token on success.
+     * @return string The packed ptgRef3d token on success.
      */
     private function convertRef3d($cell)
     {
@@ -834,7 +834,7 @@ 
      *
      * @access private
      * @param string $ext_ref The name of the external reference
-     * @return mixed The reference index in packed() format on success
+     * @return string The reference index in packed() format on success
      */
     private function getRefIndex($ext_ref)
     {
@@ -925,7 +925,7 @@ 
      *
      * @access private
      * @param string $cell The Excel cell reference to be packed
-     * @return array Array containing the row and column in packed() format
+     * @return string[] Array containing the row and column in packed() format
      */
     private function cellToPackedRowcol($cell)
     {
@@ -954,7 +954,7 @@ 
      *
      * @access private
      * @param string $range The Excel range to be packed
-     * @return array Array containing (row1,col1,row2,col2) in packed() format
+     * @return string[] Array containing (row1,col1,row2,col2) in packed() format
      */
     private function rangeToPackedRange($range)
     {
@@ -1075,7 +1075,7 @@ 
      * Checks if it's a valid token.
      *
      * @access private
-     * @param mixed $token The token to check.
+     * @param string $token The token to check.
      * @return mixed       The checked token or false on failure
      */
     private function match($token)
@@ -1157,7 +1157,7 @@ 
      * @access public
      * @param string $formula The formula to parse, without the initial equal
      *                        sign (=).
-     * @return mixed true on success
+     * @return boolean true on success
      */
     public function parse($formula)
     {