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

Indentation +2 added lines, -2 removed lines

@@ -140,8 +140,8 @@
         }
 
         $hashTablesArray = ['stylesConditionalHashTable', 'fillHashTable', 'fontHashTable',
-                                  'bordersHashTable', 'numFmtHashTable', 'drawingHashTable',
-                                  'styleHashTable',
+                                    'bordersHashTable', 'numFmtHashTable', 'drawingHashTable',
+                                    'styleHashTable',
                                 ];
 
         // Set HashTable variables

src/PhpSpreadsheet/Writer/Xls/Worksheet.php

Indentation +8 added lines, -8 removed lines

@@ -1147,14 +1147,14 @@
 
         // Pack the main data stream
         $data = pack('vvvv', $row1, $row2, $col1, $col2) .
-                          $unknown1 .
-                          $link_type .
-                          $unknown2 .
-                          $up_count .
-                          $dir_short_len .
-                          $dir_short .
-                          $unknown3 .
-                          $stream_len; /*.
+                            $unknown1 .
+                            $link_type .
+                            $unknown2 .
+                            $up_count .
+                            $dir_short_len .
+                            $dir_short .
+                            $unknown3 .
+                            $stream_len; /*.
                           $dir_long_len .
                           $unknown4     .
                           $dir_long     .

Doc Comments +9 added lines, -7 removed lines

@@ -223,10 +223,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 \PhpOffice\PhpSpreadsheet\Worksheet $phpSheet
+     * @param integer $str_total
+     * @param integer $str_unique
      */
     public function __construct(&$str_total, &$str_unique, &$str_table, &$colors, $parser, $preCalculateFormulas, $phpSheet)
     {
@@ -624,7 +626,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
      */
@@ -733,7 +735,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
      */
@@ -800,7 +802,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)
     {
@@ -847,7 +849,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
@@ -2327,8 +2329,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)
     {

docs/Examples/Calculations/DateTime/TIME.php

Indentation +3 added lines, -3 removed lines

@@ -33,7 +33,7 @@ 
 $testDates = [[3, 15],        [13, 15],    [15, 15, 15],    [3, 15, 30],
                     [15, 15, 15],    [5],        [9, 15, 0],        [9, 15, -1],
                     [13, -14, -15],    [0, 0, -1],
-                  ];
+                    ];
 $testDateCount = count($testDates);
 
 $worksheet->fromArray($testDates, null, 'A1', true);
@@ -43,8 +43,8 @@ 
     $worksheet->setCellValue('E' . $row, '=D' . $row);
 }
 $worksheet->getStyle('E1:E' . $testDateCount)
-          ->getNumberFormat()
-          ->setFormatCode('hh:mm:ss');
+            ->getNumberFormat()
+            ->setFormatCode('hh:mm:ss');
 
 echo '<hr />';
 

Spacing +3 added lines, -3 removed lines

@@ -30,9 +30,9 @@
 $worksheet = $spreadsheet->getActiveSheet();
 
 // Add some data
-$testDates = [[3, 15],        [13, 15],    [15, 15, 15],    [3, 15, 30],
-                    [15, 15, 15],    [5],        [9, 15, 0],        [9, 15, -1],
-                    [13, -14, -15],    [0, 0, -1],
+$testDates = [[3, 15], [13, 15], [15, 15, 15], [3, 15, 30],
+                    [15, 15, 15], [5], [9, 15, 0], [9, 15, -1],
+                    [13, -14, -15], [0, 0, -1],
                   ];
 $testDateCount = count($testDates);
 

docs/Examples/Calculations/DateTime/DATEVALUE.php

Indentation +3 added lines, -3 removed lines

@@ -34,7 +34,7 @@ 
                     '2012-Oct-31',        '5th November',    'January 1st',        'April 2012',
                     '17-03',            '03-2012',        '29 Feb 2011',        '03-05-07',
                     '03-MAY-07',        '03-13-07',
-                  ];
+                    ];
 $testDateCount = count($testDates);
 
 for ($row = 1; $row <= $testDateCount; ++$row) {
@@ -44,8 +44,8 @@ 
 }
 
 $worksheet->getStyle('C1:C' . $testDateCount)
-          ->getNumberFormat()
-          ->setFormatCode('yyyy-mmm-dd');
+            ->getNumberFormat()
+            ->setFormatCode('yyyy-mmm-dd');
 
 echo '<hr />';
 

Spacing +4 added lines, -4 removed lines

@@ -30,10 +30,10 @@
 $worksheet = $spreadsheet->getActiveSheet();
 
 // Add some data
-$testDates = ['26 March 2012',    '29 Feb 2012',    'April 1, 2012',    '25/12/2012',
-                    '2012-Oct-31',        '5th November',    'January 1st',        'April 2012',
-                    '17-03',            '03-2012',        '29 Feb 2011',        '03-05-07',
-                    '03-MAY-07',        '03-13-07',
+$testDates = ['26 March 2012', '29 Feb 2012', 'April 1, 2012', '25/12/2012',
+                    '2012-Oct-31', '5th November', 'January 1st', 'April 2012',
+                    '17-03', '03-2012', '29 Feb 2011', '03-05-07',
+                    '03-MAY-07', '03-13-07',
                   ];
 $testDateCount = count($testDates);
 

docs/Examples/Calculations/DateTime/TIMEVALUE.php

Indentation +3 added lines, -3 removed lines

@@ -31,7 +31,7 @@ 
 
 // Add some data
 $testDates = ['3:15',    '13:15',    '15:15:15',    '3:15 AM',    '3:15 PM',    '5PM',    '9:15AM',    '13:15AM',
-                  ];
+                    ];
 $testDateCount = count($testDates);
 
 for ($row = 1; $row <= $testDateCount; ++$row) {
@@ -41,8 +41,8 @@ 
 }
 
 $worksheet->getStyle('C1:C' . $testDateCount)
-          ->getNumberFormat()
-          ->setFormatCode('hh:mm:ss');
+            ->getNumberFormat()
+            ->setFormatCode('hh:mm:ss');
 
 echo '<hr />';
 

Spacing +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
 $worksheet = $spreadsheet->getActiveSheet();
 
 // Add some data
-$testDates = ['3:15',    '13:15',    '15:15:15',    '3:15 AM',    '3:15 PM',    '5PM',    '9:15AM',    '13:15AM',
+$testDates = ['3:15', '13:15', '15:15:15', '3:15 AM', '3:15 PM', '5PM', '9:15AM', '13:15AM',
                   ];
 $testDateCount = count($testDates);