PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Chart/Properties.php

Doc Comments +11 added lines

@@ -136,6 +136,11 @@ 
         return (string) 100 - $alpha . '000';
     }
 
+    /**
+     * @param string $color
+     * @param integer $alpha
+     * @param string $type
+     */
     protected function setColorProperties($color, $alpha, $type)
     {
         return [
@@ -145,6 +150,9 @@ 
         ];
     }
 
+    /**
+     * @param string $array_kay_selector
+     */
     protected function getLineStyleArrowSize($array_selector, $array_kay_selector)
     {
         $sizes = [
@@ -162,6 +170,9 @@ 
         return $sizes[$array_selector][$array_kay_selector];
     }
 
+    /**
+     * @param integer $shadow_presets_option
+     */
     protected function getShadowPresetsMap($shadow_presets_option)
     {
         $presets_options = [

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/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/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/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/Reader/Xlsx/Theme.php

Doc Comments +3 added lines, -3 removed lines

@@ -57,8 +57,8 @@ 
     /**
      * Create a new Theme.
      *
-     * @param mixed $themeName
-     * @param mixed $colourSchemeName
+     * @param string $themeName
+     * @param string $colourSchemeName
      * @param mixed $colourMap
      */
     public function __construct($themeName, $colourSchemeName, $colourMap)
@@ -92,7 +92,7 @@ 
     /**
      * Get colour Map Value by Position.
      *
-     * @param mixed $index
+     * @param integer $index
      *
      * @return string
      */

src/PhpSpreadsheet/Reader/Xlsx.php

Doc Comments +8 added lines

@@ -294,6 +294,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';
@@ -2159,6 +2164,9 @@ 
         return preg_replace('~[^/]+/\.\./~', '', dirname($base) . "/$add");
     }
 
+    /**
+     * @param string $style
+     */
     private static function toCSSArray($style)
     {
         $style = str_replace(["\r", "\n"], '', $style);

src/PhpSpreadsheet/Reader/Html.php

Doc Comments +13 added lines

@@ -168,16 +168,25 @@ 
         return fread($this->fileHandle, $blockSize);
     }
 
+    /**
+     * @param string $data
+     */
     private static function startsWithTag($data)
     {
         return '<' === substr(trim($data), 0, 1);
     }
 
+    /**
+     * @param string $data
+     */
     private static function endsWithTag($data)
     {
         return '>' === substr(trim($data), -1, 1);
     }
 
+    /**
+     * @param string $data
+     */
     private static function containsTags($data)
     {
         return strlen($data) !== strlen(strip_tags($data));
@@ -249,6 +258,10 @@ 
         return array_pop($this->nestedColumn);
     }
 
+    /**
+     * @param \PhpOffice\PhpSpreadsheet\Worksheet $sheet
+     * @param integer $row
+     */
     protected function flushCell($sheet, $column, $row, &$cellContent)
     {
         if (is_string($cellContent)) {

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