PHPOffice / PhpSpreadsheet

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

Doc Comments +4 added lines

@@ -202,6 +202,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/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
      */