PHPOffice / PhpSpreadsheet

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/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/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)
     {

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/Shared/JAMA/Matrix.php

Doc Comments +2 added lines, -47 removed lines

@@ -149,12 +149,6 @@ 
      *
      *    Get a submatrix
      *
-     *    @param int $i0 Initial row index
-     *    @param int $iF Final row index
-     *    @param int $j0 Initial column index
-     *    @param int $jF Final column index
-     *
-     *    @return Matrix Submatrix
      */
     public function getMatrix()
     {
@@ -365,7 +359,7 @@ 
      *
      *    @param int $m Row dimension
      *    @param int $n Column dimension
-     *    @param mixed $c Diagonal value
+     *    @param integer $c Diagonal value
      *
      *    @return Matrix Diagonal matrix
      */
@@ -449,7 +443,7 @@ 
      *
      *    Sum of diagonal elements
      *
-     *    @return float Sum of diagonal elements
+     *    @return integer Sum of diagonal elements
      */
     public function trace()
     {
@@ -478,9 +472,6 @@ 
      *
      *    A + B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function plus()
     {
@@ -521,9 +512,6 @@ 
      *
      *    A = A + B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function plusEquals()
     {
@@ -578,9 +566,6 @@ 
      *
      *    A - B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function minus()
     {
@@ -621,9 +606,6 @@ 
      *
      *    A = A - B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function minusEquals()
     {
@@ -679,9 +661,6 @@ 
      *    Element-by-element multiplication
      *    Cij = Aij * Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Cij
      */
     public function arrayTimes()
     {
@@ -723,9 +702,6 @@ 
      *    Element-by-element multiplication
      *    Aij = Aij * Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Aij
      */
     public function arrayTimesEquals()
     {
@@ -781,9 +757,6 @@ 
      *    Element-by-element right division
      *    A / B
      *
-     *    @param Matrix $B Matrix B
-     *
-     *    @return Matrix Division result
      */
     public function arrayRightDivide()
     {
@@ -844,9 +817,6 @@ 
      *    Element-by-element right division
      *    Aij = Aij / Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Aij
      */
     public function arrayRightDivideEquals()
     {
@@ -888,9 +858,6 @@ 
      *    Element-by-element Left division
      *    A / B
      *
-     *    @param Matrix $B Matrix B
-     *
-     *    @return Matrix Division result
      */
     public function arrayLeftDivide()
     {
@@ -932,9 +899,6 @@ 
      *    Element-by-element Left division
      *    Aij = Aij / Bij
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Matrix Aij
      */
     public function arrayLeftDivideEquals()
     {
@@ -975,9 +939,6 @@ 
      *
      *    Matrix multiplication
      *
-     *    @param mixed $n Matrix/Array/Scalar
-     *
-     *    @return Matrix Product
      */
     public function times()
     {
@@ -1078,9 +1039,6 @@ 
      *
      *    A = A ^ B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function power()
     {
@@ -1135,9 +1093,6 @@ 
      *
      *    A = A & B
      *
-     *    @param mixed $B Matrix/Array
-     *
-     *    @return Matrix Sum
      */
     public function concat()
     {