PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Writer/Excel5/Parser.php

Doc Comments +9 added lines, -9 removed lines

@@ -504,7 +504,7 @@ 
      *
      * @access private
      * @param mixed $token The token to convert.
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convert($token)
     {
@@ -574,7 +574,7 @@ 
      *
      * @access private
      * @param string $string A string for conversion to its ptg value.
-     * @return mixed the converted token on success
+     * @return string the converted token on success
      */
     private function convertString($string)
     {
@@ -654,7 +654,7 @@ 
      *
      * @access private
      * @param string $token An Excel range in the Sheet1!A1:A2 format.
-     * @return mixed The packed ptgArea3d token on success.
+     * @return string The packed ptgArea3d token on success.
      */
     private function convertRange3d($token)
     {
@@ -726,7 +726,7 @@ 
      *
      * @access private
      * @param string $cell An Excel cell reference
-     * @return mixed The packed ptgRef3d token on success.
+     * @return string The packed ptgRef3d token on success.
      */
     private function convertRef3d($cell)
     {
@@ -834,7 +834,7 @@ 
      *
      * @access private
      * @param string $ext_ref The name of the external reference
-     * @return mixed The reference index in packed() format on success
+     * @return string The reference index in packed() format on success
      */
     private function getRefIndex($ext_ref)
     {
@@ -925,7 +925,7 @@ 
      *
      * @access private
      * @param string $cell The Excel cell reference to be packed
-     * @return array Array containing the row and column in packed() format
+     * @return string[] Array containing the row and column in packed() format
      */
     private function cellToPackedRowcol($cell)
     {
@@ -954,7 +954,7 @@ 
      *
      * @access private
      * @param string $range The Excel range to be packed
-     * @return array Array containing (row1,col1,row2,col2) in packed() format
+     * @return string[] Array containing (row1,col1,row2,col2) in packed() format
      */
     private function rangeToPackedRange($range)
     {
@@ -1075,7 +1075,7 @@ 
      * Checks if it's a valid token.
      *
      * @access private
-     * @param mixed $token The token to check.
+     * @param string $token The token to check.
      * @return mixed       The checked token or false on failure
      */
     private function match($token)
@@ -1157,7 +1157,7 @@ 
      * @access public
      * @param string $formula The formula to parse, without the initial equal
      *                        sign (=).
-     * @return mixed true on success
+     * @return boolean true on success
      */
     public function parse($formula)
     {

src/PhpSpreadsheet/Writer/Excel5/Worksheet.php

Doc Comments +10 added lines, -8 removed lines

@@ -200,10 +200,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 boolean    $preCalculateFormulas    Flag indicating whether formulas should be calculated or just written
      * @param string    $phpSheet        The worksheet to write
      * @param \PHPExcel\Worksheet $phpSheet
+     * @param integer $str_total
+     * @param integer $str_unique
      */
     public function __construct(&$str_total, &$str_unique, &$str_table, &$colors, $parser, $preCalculateFormulas, $phpSheet)
     {
@@ -614,7 +616,7 @@ 
      * @param integer $row    Zero indexed row
      * @param integer $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 integer
      */
     private function writeNumber($row, $col, $num, $xfIndex)
@@ -652,7 +654,7 @@ 
      * @param int $row Row index (0-based)
      * @param int $col Column index (0-based)
      * @param string $str The string
-     * @param mixed   $xfIndex The XF format index for the cell
+     * @param integer   $xfIndex The XF format index for the cell
      * @param array $arrcRun Index to Font record and characters beginning
      */
     private function writeRichTextString($row, $col, $str, $xfIndex, $arrcRun)
@@ -720,7 +722,7 @@ 
      * @param integer $row    Zero indexed row
      * @param integer $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 integer
      */
     private function writeLabelSst($row, $col, $str, $xfIndex)
@@ -785,7 +787,7 @@ 
      *
      * @param integer $row    Zero indexed row
      * @param integer $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 integer $row     Zero indexed row
      * @param integer $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 integer
      */
@@ -2307,8 +2309,8 @@ 
      * @param mixed   $bitmap  The bitmap filename or GD-image resource
      * @param integer $x       The horizontal position (offset) of the image inside the cell.
      * @param integer $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/Style/Fill.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
     /**
      * Set Row Height
      *
-     * @param double $pValue
+     * @param integer $pValue
      * @return RowDimension
      */
     public function setRowHeight($pValue = -1)

src/PhpSpreadsheet/Style/Font.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
     /**
      * Set Row Height
      *
-     * @param double $pValue
+     * @param integer $pValue
      * @return RowDimension
      */
     public function setRowHeight($pValue = -1)

src/PhpSpreadsheet/Shared/Date.php

Doc Comments +7 added lines, -9 removed lines

@@ -112,7 +112,7 @@ 
     /**
      * Set the Default timezone to use for dates
      *
-     * @param     string|\DateTimeZone    $timezone    The timezone to set for all Excel datetimestamp to PHP DateTime Object conversions
+     * @param     string|\DateTimeZone    $timeZone    The timezone to set for all Excel datetimestamp to PHP DateTime Object conversions
      * @return    boolean                              Success or failure
      * @throws    \Exception
      */
@@ -141,7 +141,7 @@ 
     /**
      * Validate a timezone
      *
-     * @param     string|\DateTimeZone    $timezone    The timezone to validate, either as a timezone string or object
+     * @param     string|\DateTimeZone    $timeZone    The timezone to validate, either as a timezone string or object
      * @return    \DateTimeZone                        The timezone as a timezone object
      * @throws    \Exception
      */
@@ -158,8 +158,7 @@ 
     /**
      * Convert a MS serialized datetime value from Excel to a PHP Date/Time object
      *
-     * @param     integer|float    $dateValue        MS Excel serialized date/time value
-     * @param     \DateTimeZone|string|null          $timezone            The timezone to assume for the Excel timestamp,
+     * @param     \DateTimeZone|string|null          $timeZone            The timezone to assume for the Excel timestamp,
      *                                                                        if you don't want to treat it as a UTC value
      *                                                                    Use the default (UST) unless you absolutely need a conversion
      * @return    \DateTime                          PHP date/time object
@@ -196,8 +195,7 @@ 
     /**
      * Convert a MS serialized datetime value from Excel to a unix timestamp
      *
-     * @param     integer|float    $dateValue        MS Excel serialized date/time value
-     * @param     \DateTimeZone|string|null          $timezone            The timezone to assume for the Excel timestamp,
+     * @param     \DateTimeZone|string|null          $timeZone            The timezone to assume for the Excel timestamp,
      *                                                                        if you don't want to treat it as a UTC value
      *                                                                    Use the default (UST) unless you absolutely need a conversion
      * @return    integer                            Unix timetamp for this date/time
@@ -212,7 +210,7 @@ 
     /**
      *    Convert a date from PHP to an MS Excel serialized date/time value
      *
-     *    @param    mixed            $dateValue            PHP serialized date/time or date object
+     *    @param    integer            $dateValue            PHP serialized date/time or date object
      *    @return   float|boolean    Excel date/time value
      *                                  or boolean FALSE on failure
      */
@@ -250,7 +248,7 @@ 
     /**
      *    Convert a Unix timestamp to an MS Excel serialized date/time value
      *
-     *    @param    \DateTimeInterface    $dateValue            PHP DateTime object
+     *    @param    integer    $dateValue            PHP DateTime object
      *    @return   float                 MS Excel serialized date/time value
      */
     public static function timestampToExcel($dateValue = 0)
@@ -270,7 +268,7 @@ 
      * @param    integer    $hours
      * @param    integer    $minutes
      * @param    integer    $seconds
-     * @return   integer    Excel date/time value
+     * @return   double    Excel date/time value
      */
     public static function formattedPHPToExcel($year, $month, $day, $hours = 0, $minutes = 0, $seconds = 0)
     {

src/PhpSpreadsheet/Chart/Renderer/JpGraph.php

Doc Comments +62 added lines

@@ -62,6 +62,9 @@ 
     private static $plotMark = 0;
 
 
+    /**
+     * @param string $markerID
+     */
     private function formatPointMarker($seriesPlot, $markerID)
     {
         $plotMarkKeys = array_keys(self::$markSet);
@@ -90,6 +93,9 @@ 
     }
 
 
+    /**
+     * @param integer $labelCount
+     */
     private function formatDataSetLabels($groupID, $datasetLabels, $labelCount, $rotation = '')
     {
         $datasetLabelFormatCode = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotCategoryByIndex(0)->getFormatCode();
@@ -120,6 +126,9 @@ 
     }
 
 
+    /**
+     * @param integer $seriesCount
+     */
     private function percentageSumCalculation($groupID, $seriesCount)
     {
         //    Adjust our values to a percentage value across all series in the group
@@ -152,6 +161,9 @@ 
     }
 
 
+    /**
+     * @param \PhpSpreadsheet\Chart\Title $captionElement
+     */
     private function getCaption($captionElement)
     {
         //    Read any caption
@@ -264,6 +276,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotLine($groupID, $filled = false, $combination = false, $dimensions = '2d')
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -328,6 +343,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotBar($groupID, $dimensions = '2d')
     {
         $rotation = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotDirection();
@@ -414,6 +432,10 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     * @param boolean $bubble
+     */
     private function renderPlotScatter($groupID, $bubble)
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -460,6 +482,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotRadar($groupID)
     {
         $radarStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -499,6 +524,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotContour($groupID)
     {
         $contourStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -520,6 +548,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotStock($groupID)
     {
         $seriesCount = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotSeriesCount();
@@ -560,6 +591,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderAreaChart($groupCount, $dimensions = '2d')
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_line.php');
@@ -572,6 +606,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderLineChart($groupCount, $dimensions = '2d')
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_line.php');
@@ -584,6 +621,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBarChart($groupCount, $dimensions = '2d')
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_bar.php');
@@ -596,6 +636,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderScatterChart($groupCount)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_scatter.php');
@@ -610,6 +653,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBubbleChart($groupCount)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_scatter.php');
@@ -622,6 +668,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderPieChart($groupCount, $dimensions = '2d', $doughnut = false, $multiplePlots = false)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_pie.php');
@@ -699,6 +748,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderRadarChart($groupCount)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_radar.php');
@@ -711,6 +763,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderStockChart($groupCount)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_stock.php');
@@ -723,6 +778,10 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     * @param string|null $dimensions
+     */
     private function renderContourChart($groupCount, $dimensions)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_contour.php');
@@ -735,6 +794,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderCombinationChart($groupCount, $dimensions, $outputDestination)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_line.php');

src/PhpSpreadsheet/Document/Properties.php

Doc Comments +2 added lines, -2 removed lines

@@ -177,7 +177,7 @@ 
     /**
      * Get Created
      *
-     * @return datetime
+     * @return integer|null
      */
     public function getCreated()
     {
@@ -209,7 +209,7 @@ 
     /**
      * Get Modified
      *
-     * @return datetime
+     * @return integer|null
      */
     public function getModified()
     {

src/PhpSpreadsheet/Reader/Excel2007.php

Doc Comments +18 added lines, -1 removed lines

@@ -285,6 +285,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)
     {
 //        echo 'Formula', PHP_EOL;
@@ -327,6 +332,9 @@ 
     }
 
 
+    /**
+     * @return string|null
+     */
     private function getFromZipArchive($archive, $fileName = '')
     {
         // Root-relative paths
@@ -356,7 +364,7 @@ 
      * Loads Spreadsheet from file
      *
      * @param     string         $pFilename
-     * @return    Spreadsheet
+     * @return    \PhpSpreadsheet\Spreadsheet
      * @throws    Exception
      */
     public function load($pFilename)
@@ -1921,6 +1929,9 @@ 
         return 'FF000000';
     }
 
+    /**
+     * @param \PhpSpreadsheet\Style $docStyle
+     */
     private static function readStyle($docStyle, $style)
     {
         // format code
@@ -2120,6 +2131,9 @@ 
         return $value;
     }
 
+    /**
+     * @param \PhpSpreadsheet\Spreadsheet $excel
+     */
     private function readRibbon($excel, $customUITarget, $zip)
     {
         $baseDir = dirname($customUITarget);
@@ -2172,6 +2186,9 @@ 
         return preg_replace('~[^/]+/\.\./~', '', dirname($base) . "/$add");
     }
 
+    /**
+     * @param string $style
+     */
     private static function toCSSArray($style)
     {
         $style = str_replace(array("\r","\n"), "", $style);

src/PhpSpreadsheet/Reader/Excel2007/Chart.php

Doc Comments +14 added lines

@@ -26,6 +26,10 @@ 
  */
 class Chart
 {
+    /**
+     * @param string $name
+     * @param string $format
+     */
     private static function getAttribute($component, $name, $format)
     {
         $attributes = $component->attributes();
@@ -53,6 +57,10 @@ 
         }
     }
 
+    /**
+     * @param \SimpleXMLElement $chartElements
+     * @param string $chartName
+     */
     public static function readChart($chartElements, $chartName)
     {
         $namespacesChartMeta = $chartElements->getNamespaces(true);
@@ -195,6 +203,9 @@ 
         return $chart;
     }
 
+    /**
+     * @param string $type
+     */
     private static function chartTitle($titleDetails, $namespacesChartMeta, $type)
     {
         $caption = array();
@@ -481,6 +492,9 @@ 
         return $plotAttributes;
     }
 
+    /**
+     * @param \PhpSpreadsheet\Chart\Layout $plotArea
+     */
     private static function setChartAttributes($plotArea, $plotAttributes)
     {
         foreach ($plotAttributes as $plotAttributeKey => $plotAttributeValue) {