PHPOffice / PhpSpreadsheet

docs/Examples/Reader/exampleReader01.php

Spacing +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 require_once __DIR__ . '/../../../src/Bootstrap.php';
 
 $inputFileName = './sampleData/example1.xls';
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' using IOFactory to identify the format<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' using IOFactory to identify the format<br />';
 $spreadsheet = IOFactory::load($inputFileName);
 
 echo '<hr />';

docs/Examples/Reader/exampleReader08.php

Spacing +4 added lines, -4 removed lines

@@ -31,18 +31,18 @@
 $inputFileName = './sampleData/example1.xls';
 $sheetnames = ['Data Sheet #1', 'Data Sheet #3'];
 
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' using IOFactory with a defined reader type of ',$inputFileType,'<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' using IOFactory with a defined reader type of ', $inputFileType, '<br />';
 $reader = IOFactory::createReader($inputFileType);
-echo 'Loading Sheet',((count($sheetnames) == 1) ? '' : 's'),' "',implode('" and "', $sheetnames),'" only<br />';
+echo 'Loading Sheet', ((count($sheetnames) == 1) ? '' : 's'), ' "', implode('" and "', $sheetnames), '" only<br />';
 $reader->setLoadSheetsOnly($sheetnames);
 $spreadsheet = $reader->load($inputFileName);
 
 echo '<hr />';
 
-echo $spreadsheet->getSheetCount(),' worksheet',(($spreadsheet->getSheetCount() == 1) ? '' : 's'),' loaded<br /><br />';
+echo $spreadsheet->getSheetCount(), ' worksheet', (($spreadsheet->getSheetCount() == 1) ? '' : 's'), ' loaded<br /><br />';
 $loadedSheetNames = $spreadsheet->getSheetNames();
 foreach ($loadedSheetNames as $sheetIndex => $loadedSheetName) {
-    echo $sheetIndex,' -> ',$loadedSheetName,'<br />';
+    echo $sheetIndex, ' -> ', $loadedSheetName, '<br />';
 }
 
 ?>

docs/Examples/Reader/exampleReader18.php

Spacing +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
 //	$inputFileType = 'Gnumeric';
 $inputFileName = './sampleData/example1.xls';
 
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' information using IOFactory with a defined reader type of ',$inputFileType,'<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' information using IOFactory with a defined reader type of ', $inputFileType, '<br />';
 
 $reader = IOFactory::createReader($inputFileType);
 $worksheetNames = $reader->listWorksheetNames($inputFileName);

docs/Examples/Reader/exampleReader05.php

Spacing +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
 //	$inputFileType = 'Gnumeric';
 $inputFileName = './sampleData/example1.xls';
 
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' using IOFactory with a defined reader type of ',$inputFileType,'<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' using IOFactory with a defined reader type of ', $inputFileType, '<br />';
 $reader = IOFactory::createReader($inputFileType);
 echo 'Turning Formatting off for Load<br />';
 $reader->setReadDataOnly(true);

docs/Examples/Reader/exampleReader06.php

Spacing +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
 //	$inputFileType = 'Gnumeric';
 $inputFileName = './sampleData/example1.xls';
 
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' using IOFactory with a defined reader type of ',$inputFileType,'<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' using IOFactory with a defined reader type of ', $inputFileType, '<br />';
 $reader = IOFactory::createReader($inputFileType);
 echo 'Loading all WorkSheets<br />';
 $reader->setLoadAllSheets();

docs/Examples/Reader/exampleReader16.php

Spacing +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 require_once __DIR__ . '/../../../src/Bootstrap.php';
 
 $inputFileName = './sampleData/example_1.xls';
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' using IOFactory to identify the format<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' using IOFactory to identify the format<br />';
 try {
     $spreadsheet = IOFactory::load($inputFileName);
 } catch (\InvalidArgumentException $e) {

docs/Examples/Reader/exampleReader10.php

Spacing +2 added lines, -2 removed lines

@@ -60,9 +60,9 @@
 
 $filterSubset = new MyReadFilter(9, 15, range('G', 'K'));
 
-echo 'Loading file ',pathinfo($inputFileName, PATHINFO_BASENAME),' using IOFactory with a defined reader type of ',$inputFileType,'<br />';
+echo 'Loading file ', pathinfo($inputFileName, PATHINFO_BASENAME), ' using IOFactory with a defined reader type of ', $inputFileType, '<br />';
 $reader = IOFactory::createReader($inputFileType);
-echo 'Loading Sheet "',$sheetname,'" only<br />';
+echo 'Loading Sheet "', $sheetname, '" only<br />';
 $reader->setLoadSheetsOnly($sheetname);
 echo 'Loading Sheet using configurable filter<br />';
 $reader->setReadFilter($filterSubset);

src/PhpSpreadsheet/Calculation/Financial.php

Doc Comments +48 added lines, -41 removed lines

@@ -62,6 +62,10 @@ 
         return $testDate->format('d') == 1;
     }
 
+    /**
+     * @param integer $frequency
+     * @param boolean $next
+     */
     private static function couponFirstPeriodDate($settlement, $maturity, $frequency, $next)
     {
         $months = 12 / $frequency;
@@ -83,6 +87,9 @@ 
         return Date::PHPToExcel($result);
     }
 
+    /**
+     * @param integer $frequency
+     */
     private static function isValidFrequency($frequency)
     {
         if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) {
@@ -161,7 +168,7 @@ 
      *                                    The security settlement date is the date after the issue date
      *                                    when the security is traded to the buyer.
      * @param float $rate the security's annual coupon rate
-     * @param float $par The security's par value.
+     * @param integer $par The security's par value.
      *                                    If you omit par, ACCRINT uses $1,000.
      * @param int $frequency the number of coupon payments per year.
      *                                    Valid frequency values are:
@@ -234,8 +241,8 @@ 
      * @param mixed $issue
      * @param mixed $settlement
      * @param mixed $rate
-     * @param mixed $par
-     * @param mixed $basis
+     * @param integer $par
+     * @param integer $basis
      *
      * @return float
      */
@@ -301,7 +308,7 @@ 
      * @param mixed $salvage
      * @param mixed $period
      * @param mixed $rate
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -386,7 +393,7 @@ 
      * @param mixed $salvage
      * @param mixed $period
      * @param mixed $rate
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -456,8 +463,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return float
      */
@@ -520,7 +527,7 @@ 
      * @param int $frequency
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -599,8 +606,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return float
      */
@@ -663,7 +670,7 @@ 
      * @param mixed $settlement
      * @param mixed $maturity
      * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
@@ -724,8 +731,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return int
      */
@@ -801,7 +808,7 @@ 
      * @param mixed $settlement
      * @param mixed $maturity
      * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
@@ -953,7 +960,7 @@ 
      * @param mixed $salvage
      * @param mixed $life
      * @param mixed $period
-     * @param mixed $month
+     * @param integer $month
      *
      * @return float
      */
@@ -1028,7 +1035,7 @@ 
      * @param mixed $salvage
      * @param mixed $life
      * @param mixed $period
-     * @param mixed $factor
+     * @param double $factor
      *
      * @return float
      */
@@ -1097,7 +1104,7 @@ 
      * @param mixed $maturity
      * @param mixed $price
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1216,7 +1223,7 @@ 
      *
      * @category Financial Functions
      *
-     * @param float $nominal_rate Nominal interest rate
+     * @param integer $nominal_rate Nominal interest rate
      * @param int $npery Number of compounding payments per year
      *
      * @return float
@@ -1244,12 +1251,12 @@ 
      *
      * @category Financial Functions
      *
-     * @param float $rate The interest rate per period
+     * @param integer $rate The interest rate per period
      * @param int $nper Total number of payment periods in an annuity
-     * @param float $pmt The payment made each period: it cannot change over the
+     * @param integer $pmt The payment made each period: it cannot change over the
      *                            life of the annuity. Typically, pmt contains principal
      *                            and interest but no other fees or taxes.
-     * @param float $pv present Value, or the lump-sum amount that a series of
+     * @param integer $pv present Value, or the lump-sum amount that a series of
      *                            future payments is worth right now
      * @param int $type A number 0 or 1 and indicates when payments are due:
      *                                0 or omitted    At the end of the period.
@@ -1367,7 +1374,7 @@ 
      * @param int $per Period for which we want to find the interest
      * @param int $nper Number of periods
      * @param float $pv Present Value
-     * @param float $fv Future Value
+     * @param integer $fv Future Value
      * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      *
      * @return float
@@ -1562,7 +1569,7 @@ 
      *
      * Returns the nominal interest rate given the effective rate and the number of compounding payments per year.
      *
-     * @param float $effect_rate Effective interest rate
+     * @param integer $effect_rate Effective interest rate
      * @param int $npery Number of compounding payments per year
      *
      * @return float
@@ -1586,10 +1593,10 @@ 
      *
      * Returns the number of periods for a cash flow with constant periodic payments (annuities), and interest rate.
      *
-     * @param float $rate Interest rate per period
+     * @param integer $rate Interest rate per period
      * @param int $pmt Periodic payment (annuity)
-     * @param float $pv Present Value
-     * @param float $fv Future Value
+     * @param integer $pv Present Value
+     * @param integer $fv Future Value
      * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      *
      * @return float
@@ -1655,10 +1662,10 @@ 
      *
      * Returns the constant payment (annuity) for a cash flow with a constant interest rate.
      *
-     * @param float $rate Interest rate per period
+     * @param integer $rate Interest rate per period
      * @param int $nper Number of periods
-     * @param float $pv Present Value
-     * @param float $fv Future Value
+     * @param integer $pv Present Value
+     * @param integer $fv Future Value
      * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      *
      * @return float
@@ -1693,7 +1700,7 @@ 
      * @param int $per Period for which we want to find the interest
      * @param int $nper Number of periods
      * @param float $pv Present Value
-     * @param float $fv Future Value
+     * @param integer $fv Future Value
      * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      *
      * @return float
@@ -1783,7 +1790,7 @@ 
      * @param mixed $maturity
      * @param mixed $discount
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1835,7 +1842,7 @@ 
      * @param mixed $issue
      * @param mixed $rate
      * @param mixed $yield
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1889,10 +1896,10 @@ 
      *
      * Returns the Present Value of a cash flow with constant payments and interest rate (annuities).
      *
-     * @param float $rate Interest rate per period
+     * @param integer $rate Interest rate per period
      * @param int $nper Number of periods
-     * @param float $pmt Periodic payment (annuity)
-     * @param float $fv Future Value
+     * @param integer $pmt Periodic payment (annuity)
+     * @param integer $fv Future Value
      * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      *
      * @return float
@@ -1949,9 +1956,9 @@ 
      * @param mixed $nper
      * @param mixed $pmt
      * @param mixed $pv
-     * @param mixed $fv
-     * @param mixed $type
-     * @param mixed $guess
+     * @param double $fv
+     * @param integer $type
+     * @param double $guess
      *
      * @return float
      **/
@@ -2020,7 +2027,7 @@ 
      * @param mixed $maturity
      * @param mixed $investment
      * @param mixed $discount
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -2390,7 +2397,7 @@ 
      * @param mixed $maturity
      * @param mixed $price
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -2447,7 +2454,7 @@ 
      * @param mixed $issue
      * @param mixed $rate
      * @param mixed $price
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */

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 Settings::getChartRendererPath() . 'jpgraph_line.php';
@@ -553,6 +587,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderLineChart($groupCount, $dimensions = '2d')
     {
         require_once Settings::getChartRendererPath() . 'jpgraph_line.php';
@@ -564,6 +601,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBarChart($groupCount, $dimensions = '2d')
     {
         require_once Settings::getChartRendererPath() . 'jpgraph_bar.php';
@@ -575,6 +615,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderScatterChart($groupCount)
     {
         require_once Settings::getChartRendererPath() . 'jpgraph_scatter.php';
@@ -588,6 +631,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBubbleChart($groupCount)
     {
         require_once Settings::getChartRendererPath() . 'jpgraph_scatter.php';
@@ -599,6 +645,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderPieChart($groupCount, $dimensions = '2d', $doughnut = false, $multiplePlots = false)
     {
         require_once Settings::getChartRendererPath() . 'jpgraph_pie.php';
@@ -675,6 +724,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderRadarChart($groupCount)
     {
         require_once Settings::getChartRendererPath() . 'jpgraph_radar.php';
@@ -686,6 +738,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderStockChart($groupCount)
     {
         require_once Settings::getChartRendererPath() . 'jpgraph_stock.php';
@@ -697,6 +752,10 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     * @param string|null $dimensions
+     */
     private function renderContourChart($groupCount, $dimensions)
     {
         require_once Settings::getChartRendererPath() . 'jpgraph_contour.php';
@@ -708,6 +767,9 @@ 
         }
     }
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderCombinationChart($groupCount, $dimensions, $outputDestination)
     {
         require_once Settings::getChartRendererPath() . 'jpgraph_line.php';