PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Cell.php

Doc Comments +2 added lines, -2 removed lines

@@ -575,7 +575,7 @@ 
      *
      *    @param    string    $pCoordinateString
      *    @throws    Exception
-     *    @return    array    Array containing column and row (indexes 0 and 1)
+     *    @return    string[]    Array containing column and row (indexes 0 and 1)
      */
     public static function coordinateFromString($pCoordinateString = 'A1')
     {
@@ -757,7 +757,7 @@ 
      *    Calculate range boundaries
      *
      *    @param    string    $pRange        Cell range (e.g. A1:A1)
-     *    @return    array    Range coordinates array(Start Cell, End Cell)
+     *    @return    integer    Range coordinates array(Start Cell, End Cell)
      *                    where Start Cell and End Cell are arrays (Column ID, Row Number)
      */
     public static function getRangeBoundaries($pRange = 'A1:A1')

Indentation +3 added lines, -3 removed lines

@@ -845,11 +845,11 @@
                 $_indexCache[$pColumnIndex] = chr(65 + $pColumnIndex);
             } elseif ($pColumnIndex < 702) {
                 $_indexCache[$pColumnIndex] = chr(64 + ($pColumnIndex / 26)) .
-                                              chr(65 + $pColumnIndex % 26);
+                                                chr(65 + $pColumnIndex % 26);
             } else {
                 $_indexCache[$pColumnIndex] = chr(64 + (($pColumnIndex - 26) / 676)) .
-                                              chr(65 + ((($pColumnIndex - 26) % 676) / 26)) .
-                                              chr(65 + $pColumnIndex % 26);
+                                                chr(65 + ((($pColumnIndex - 26) % 676) / 26)) .
+                                                chr(65 + $pColumnIndex % 26);
             }
         }
 

src/PhpSpreadsheet/Chart/DataSeries.php

Doc Comments +3 added lines, -3 removed lines

@@ -177,7 +177,7 @@ 
     /**
      * Get Plot Grouping Type
      *
-     * @return string
+     * @return boolean
      */
     public function getPlotGrouping()
     {
@@ -200,7 +200,7 @@ 
     /**
      * Get Plot Direction
      *
-     * @return string
+     * @return boolean
      */
     public function getPlotDirection()
     {
@@ -347,7 +347,7 @@ 
     /**
      * Get Smooth Line
      *
-     * @return bool
+     * @return string
      */
     public function getSmoothLine()
     {

Spacing +2 added lines, -2 removed lines

@@ -35,14 +35,14 @@
     const TYPE_PIECHART = 'pieChart';
     const TYPE_PIECHART_3D = 'pie3DChart';
     const TYPE_DOUGHTNUTCHART = 'doughnutChart';
-    const TYPE_DONUTCHART = self::TYPE_DOUGHTNUTCHART;    //    Synonym
+    const TYPE_DONUTCHART = self::TYPE_DOUGHTNUTCHART; //    Synonym
     const TYPE_SCATTERCHART = 'scatterChart';
     const TYPE_SURFACECHART = 'surfaceChart';
     const TYPE_SURFACECHART_3D = 'surface3DChart';
     const TYPE_RADARCHART = 'radarChart';
     const TYPE_BUBBLECHART = 'bubbleChart';
     const TYPE_STOCKCHART = 'stockChart';
-    const TYPE_CANDLECHART = self::TYPE_STOCKCHART;       //    Synonym
+    const TYPE_CANDLECHART = self::TYPE_STOCKCHART; //    Synonym
 
     const GROUPING_CLUSTERED = 'clustered';
     const GROUPING_STACKED = 'stacked';

src/PhpSpreadsheet/Chart/DataSeriesValues.php

Doc Comments +3 added lines, -2 removed lines

@@ -80,6 +80,7 @@ 
 
     /**
      * Create a new DataSeriesValues object
+     * @param string $dataSource
      */
     public function __construct($dataType = self::DATASERIES_TYPE_NUMBER, $dataSource = null, $formatCode = null, $pointCount = 0, $dataValues = [], $marker = null)
     {
@@ -209,7 +210,7 @@ 
     /**
      * Identify if the Data Series is a multi-level or a simple series
      *
-     * @return    bool
+     * @return    boolean|null
      */
     public function isMultiLevelSeries()
     {
@@ -223,7 +224,7 @@ 
     /**
      * Return the level count of a multi-level Data Series
      *
-     * @return    bool
+     * @return    integer
      */
     public function multiLevelCount()
     {

src/PhpSpreadsheet/Reader/CSV.php

Doc Comments +1 added lines, -1 removed lines

@@ -387,7 +387,7 @@
     /**
      * Get Contiguous
      *
-     * @return bool
+     * @return integer
      */
     public function getContiguous()
     {

Indentation +2 added lines, -2 removed lines

@@ -254,8 +254,8 @@
         $sheet = $spreadsheet->setActiveSheetIndex($this->sheetIndex);
 
         $escapeEnclosures = ['\\' . $this->enclosure,
-                                   $this->enclosure . $this->enclosure,
-                                 ];
+                                    $this->enclosure . $this->enclosure,
+                                    ];
 
         // Set our starting row based on whether we're in contiguous mode or not
         $currentRow = 1;

Spacing +1 added lines, -1 removed lines

@@ -260,7 +260,7 @@
         // Set our starting row based on whether we're in contiguous mode or not
         $currentRow = 1;
         if ($this->contiguous) {
-            $currentRow = ($this->contiguousRow == -1) ? $sheet->getHighestRow(): $this->contiguousRow;
+            $currentRow = ($this->contiguousRow == -1) ? $sheet->getHighestRow() : $this->contiguousRow;
         }
 
         // Loop through each line of the file in turn

src/PhpSpreadsheet/Reader/Excel5.php

Doc Comments +16 added lines, -7 removed lines

@@ -1207,7 +1207,7 @@ 
      *
      * @param string $data   Data stream to read from
      * @param int    $pos    Position to start reading from
-     * @param int    $length Record data length
+     * @param integer $len
      *
      * @return string Record data
      */
@@ -1743,6 +1743,7 @@ 
      * @var int         Block for which to create decrypto
      * @var string $valContext MD5 context state
      *
+     * @param string $valContext
      * @return Excel5\RC4
      */
     private function makeKey($block, $valContext)
@@ -1778,6 +1779,11 @@ 
      * @var string $hashedsalt_data Hashed salt data
      * @var string &$valContext     Set to the MD5 context of the value
      *
+     * @param string $password
+     * @param string $docid
+     * @param string $salt_data
+     * @param string $hashedsalt_data
+     * @param string $valContext
      * @return bool Success
      */
     private function verifyPassword($password, $docid, $salt_data, $hashedsalt_data, &$valContext)
@@ -5157,7 +5163,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()
     {
@@ -5257,8 +5263,7 @@ 
      * Take array of tokens together with additional data for formula and return human readable formula
      *
      * @param array $tokens
-     * @param array $additionalData Additional binary data going with the formula
-     * @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
+     * @param string $additionalData Additional binary data going with the formula
      * @return string Human readable formula
      */
     private function createFormulaFromTokens($tokens, $additionalData)
@@ -5421,8 +5426,9 @@ 
      *
      * @param string Formula data
      * @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
+     * @param string $formulaData
      * @throws Exception
-     * @return array
+     * @return string
      */
     private function getNextToken($formulaData, $baseCell = 'A1')
     {
@@ -6990,7 +6996,7 @@ 
      * section 2.5.15
      *
      * @param string $subData
-     * @return array
+     * @return string
      */
     private function readBIFF8CellRangeAddressList($subData)
     {
@@ -7372,6 +7378,9 @@ 
         return $value;
     }
 
+    /**
+     * @param integer $rknum
+     */
     private static function getIEEE754($rknum)
     {
         if (($rknum & 0x02) != 0) {
@@ -7402,7 +7411,7 @@ 
      * Get UTF-8 string from (compressed or uncompressed) UTF-16 string
      *
      * @param string $string
-     * @param bool $compressed
+     * @param string|boolean $compressed
      * @return string
      */
     private static function encodeUTF16($string, $compressed = '')

Spacing +1 added lines, -1 removed lines

@@ -1122,7 +1122,7 @@
                             // $range should look like one of these
                             //        Foo!$C$7:$J$66
                             //        Bar!$A$1:$IV$2
-                            $explodes = explode('!', $range);    // FIXME: what if sheetname contains exclamation mark?
+                            $explodes = explode('!', $range); // FIXME: what if sheetname contains exclamation mark?
                             $sheetName = trim($explodes[0], "'");
                             if (count($explodes) == 2) {
                                 if (strpos($explodes[1], ':') === false) {

src/PhpSpreadsheet/Shared/Date.php

Doc Comments +7 added lines, -9 removed lines

@@ -113,7 +113,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
      * @throws    \Exception
      * @return    bool                              Success or failure
      */
@@ -145,7 +145,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
      * @throws    \Exception
      * @return    \DateTimeZone                        The timezone as a timezone object
      */
@@ -162,8 +162,7 @@ 
     /**
      * Convert a MS serialized datetime value from Excel to a PHP Date/Time object
      *
-     * @param     int|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
      * @throws    \Exception
@@ -201,8 +200,7 @@ 
     /**
      * Convert a MS serialized datetime value from Excel to a unix timestamp
      *
-     * @param     int|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
      * @throws    \Exception
@@ -217,7 +215,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|bool    Excel date/time value
      *                                  or boolean FALSE on failure
      */
@@ -255,7 +253,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)
@@ -276,7 +274,7 @@ 
      * @param    int    $hours
      * @param    int    $minutes
      * @param    int    $seconds
-     * @return   int    Excel date/time value
+     * @return   double    Excel date/time value
      */
     public static function formattedPHPToExcel($year, $month, $day, $hours = 0, $minutes = 0, $seconds = 0)
     {

Spacing +2 added lines, -2 removed lines

@@ -29,8 +29,8 @@
 class Date
 {
     /** constants */
-    const CALENDAR_WINDOWS_1900 = 1900;        //    Base date of 1st Jan 1900 = 1.0
-    const CALENDAR_MAC_1904 = 1904;            //    Base date of 2nd Jan 1904 = 1.0
+    const CALENDAR_WINDOWS_1900 = 1900; //    Base date of 1st Jan 1900 = 1.0
+    const CALENDAR_MAC_1904 = 1904; //    Base date of 2nd Jan 1904 = 1.0
 
     /*
      * Names of the months of the year, indexed by shortname

src/PhpSpreadsheet/Shared/OLE.php

Doc Comments +6 added lines, -2 removed lines

@@ -93,7 +93,7 @@ 
      * @acces public
      * @param string $file
      * @throws \PhpSpreadsheet\Reader\Exception
-     * @return mixed true on success, PEAR_Error on failure
+     * @return boolean true on success, PEAR_Error on failure
      */
     public function read($file)
     {
@@ -223,6 +223,7 @@ 
     /**
      * Reads a signed char.
      * @param   resource  file handle
+     * @param resource $fh
      * @return  int
      */
     private static function _readInt1($fh)
@@ -235,6 +236,7 @@ 
     /**
      * Reads an unsigned short (2 octets).
      * @param   resource  file handle
+     * @param resource $fh
      * @return  int
      */
     private static function _readInt2($fh)
@@ -247,6 +249,7 @@ 
     /**
      * Reads an unsigned long (4 octets).
      * @param   resource  file handle
+     * @param resource $fh
      * @return  int
      */
     private static function _readInt4($fh)
@@ -261,7 +264,8 @@ 
      * creates an OLE_PPS object for each one.
      *
      * @param  int  the block id of the first block
-     * @return mixed true on success, PEAR_Error on failure
+     * @param integer $blockId
+     * @return boolean true on success, PEAR_Error on failure
      */
     public function _readPpsWks($blockId)
     {

Spacing +1 added lines, -1 removed lines

@@ -266,7 +266,7 @@
     public function _readPpsWks($blockId)
     {
         $fh = $this->getStream($blockId);
-        for ($pos = 0;; $pos += 128) {
+        for ($pos = 0; ; $pos += 128) {
             fseek($fh, $pos, SEEK_SET);
             $nameUtf16 = fread($fh, 64);
             $nameLength = self::_readInt2($fh);

src/PhpSpreadsheet/Shared/OLE/PPS/Root.php

Doc Comments +5 added lines, -4 removed lines

@@ -39,6 +39,7 @@ 
     /**
      * @param int $time_1st A timestamp
      * @param int $time_2nd A timestamp
+     * @param File[] $raChild
      */
     public function __construct($time_1st, $time_2nd, $raChild)
     {
@@ -54,9 +55,9 @@ 
      * If a resource pointer to a stream created by fopen() is passed
      * it will be used, but you have to close such stream by yourself.
      *
-     * @param string|resource $filename The name of the file or stream where to save the OLE container.
+     * @param string|null $filename The name of the file or stream where to save the OLE container.
      * @throws \PhpSpreadsheet\Writer\Exception
-     * @return mixed true on success
+     * @return boolean true on success
      */
     public function save($filename)
     {
@@ -116,7 +117,7 @@ 
      * Calculate some numbers
      *
      * @param array $raList Reference to an array of PPS's
-     * @return array The array of numbers
+     * @return double[] The array of numbers
      */
     public function _calcSize(&$raList)
     {
@@ -154,7 +155,7 @@ 
      *
      * @param int $i2 The argument
      * @see save()
-     * @return int
+     * @return double
      */
     private static function adjust2($i2)
     {

Spacing +18 added lines, -18 removed lines

@@ -63,11 +63,11 @@ 
         // Initial Setting for saving
         $this->_BIG_BLOCK_SIZE = pow(
             2,
-            (isset($this->_BIG_BLOCK_SIZE))? self::adjust2($this->_BIG_BLOCK_SIZE) : 9
+            (isset($this->_BIG_BLOCK_SIZE)) ? self::adjust2($this->_BIG_BLOCK_SIZE) : 9
         );
         $this->_SMALL_BLOCK_SIZE = pow(
             2,
-            (isset($this->_SMALL_BLOCK_SIZE))?  self::adjust2($this->_SMALL_BLOCK_SIZE) : 6
+            (isset($this->_SMALL_BLOCK_SIZE)) ? self::adjust2($this->_SMALL_BLOCK_SIZE) : 6
         );
 
         if (is_resource($filename)) {
@@ -130,21 +130,21 @@ 
                 $raList[$i]->Size = $raList[$i]->getDataLen();
                 if ($raList[$i]->Size < \PhpSpreadsheet\Shared\OLE::OLE_DATA_SIZE_SMALL) {
                     $iSBcnt += floor($raList[$i]->Size / $this->_SMALL_BLOCK_SIZE)
-                                  + (($raList[$i]->Size % $this->_SMALL_BLOCK_SIZE)? 1: 0);
+                                  + (($raList[$i]->Size % $this->_SMALL_BLOCK_SIZE) ? 1 : 0);
                 } else {
                     $iBBcnt += (floor($raList[$i]->Size / $this->_BIG_BLOCK_SIZE) +
-                        (($raList[$i]->Size % $this->_BIG_BLOCK_SIZE)? 1: 0));
+                        (($raList[$i]->Size % $this->_BIG_BLOCK_SIZE) ? 1 : 0));
                 }
             }
         }
         $iSmallLen = $iSBcnt * $this->_SMALL_BLOCK_SIZE;
         $iSlCnt = floor($this->_BIG_BLOCK_SIZE / \PhpSpreadsheet\Shared\OLE::OLE_LONG_INT_SIZE);
-        $iSBDcnt = floor($iSBcnt / $iSlCnt) + (($iSBcnt % $iSlCnt)? 1:0);
+        $iSBDcnt = floor($iSBcnt / $iSlCnt) + (($iSBcnt % $iSlCnt) ? 1 : 0);
         $iBBcnt += (floor($iSmallLen / $this->_BIG_BLOCK_SIZE) +
-                      (($iSmallLen % $this->_BIG_BLOCK_SIZE)? 1: 0));
+                      (($iSmallLen % $this->_BIG_BLOCK_SIZE) ? 1 : 0));
         $iCnt = count($raList);
         $iBdCnt = $this->_BIG_BLOCK_SIZE / \PhpSpreadsheet\Shared\OLE::OLE_PPS_SIZE;
-        $iPPScnt = (floor($iCnt / $iBdCnt) + (($iCnt % $iBdCnt)? 1: 0));
+        $iPPScnt = (floor($iCnt / $iBdCnt) + (($iCnt % $iBdCnt) ? 1 : 0));
 
         return [$iSBDcnt, $iBBcnt, $iPPScnt];
     }
@@ -160,7 +160,7 @@ 
     {
         $iWk = log($i2) / log(2);
 
-        return ($iWk > floor($iWk))? floor($iWk) + 1:$iWk;
+        return ($iWk > floor($iWk)) ? floor($iWk) + 1 : $iWk;
     }
 
     /**
@@ -181,16 +181,16 @@ 
         $iBdExL = 0;
         $iAll = $iBBcnt + $iPPScnt + $iSBDcnt;
         $iAllW = $iAll;
-        $iBdCntW = floor($iAllW / $iBlCnt) + (($iAllW % $iBlCnt)? 1: 0);
-        $iBdCnt = floor(($iAll + $iBdCntW) / $iBlCnt) + ((($iAllW + $iBdCntW) % $iBlCnt)? 1: 0);
+        $iBdCntW = floor($iAllW / $iBlCnt) + (($iAllW % $iBlCnt) ? 1 : 0);
+        $iBdCnt = floor(($iAll + $iBdCntW) / $iBlCnt) + ((($iAllW + $iBdCntW) % $iBlCnt) ? 1 : 0);
 
         // Calculate BD count
         if ($iBdCnt > $i1stBdL) {
             while (1) {
                 ++$iBdExL;
                 ++$iAllW;
-                $iBdCntW = floor($iAllW / $iBlCnt) + (($iAllW % $iBlCnt)? 1: 0);
-                $iBdCnt = floor(($iAllW + $iBdCntW) / $iBlCnt) + ((($iAllW + $iBdCntW) % $iBlCnt)? 1: 0);
+                $iBdCntW = floor($iAllW / $iBlCnt) + (($iAllW % $iBlCnt) ? 1 : 0);
+                $iBdCnt = floor(($iAllW + $iBdCntW) / $iBlCnt) + ((($iAllW + $iBdCntW) % $iBlCnt) ? 1 : 0);
                 if ($iBdCnt <= ($iBdExL * $iBlCnt + $i1stBdL)) {
                     break;
                 }
@@ -278,7 +278,7 @@ 
                     $raList[$i]->startBlock = $iStBlk;
                     $iStBlk +=
                             (floor($raList[$i]->Size / $this->_BIG_BLOCK_SIZE) +
-                                (($raList[$i]->Size % $this->_BIG_BLOCK_SIZE)? 1: 0));
+                                (($raList[$i]->Size % $this->_BIG_BLOCK_SIZE) ? 1 : 0));
                 }
                 // Close file for each PPS, and unlink it
                 //if (isset($raList[$i]->_PPS_FILE)) {
@@ -310,7 +310,7 @@ 
                 }
                 if ($raList[$i]->Size < \PhpSpreadsheet\Shared\OLE::OLE_DATA_SIZE_SMALL) {
                     $iSmbCnt = floor($raList[$i]->Size / $this->_SMALL_BLOCK_SIZE)
-                                  + (($raList[$i]->Size % $this->_SMALL_BLOCK_SIZE)? 1: 0);
+                                  + (($raList[$i]->Size % $this->_SMALL_BLOCK_SIZE) ? 1 : 0);
                     // Add to SBD
                     $jB = $iSmbCnt - 1;
                     for ($j = 0; $j < $jB; ++$j) {
@@ -384,15 +384,15 @@ 
         $iBdExL = 0;
         $iAll = $iBsize + $iPpsCnt + $iSbdSize;
         $iAllW = $iAll;
-        $iBdCntW = floor($iAllW / $iBbCnt) + (($iAllW % $iBbCnt)? 1: 0);
-        $iBdCnt = floor(($iAll + $iBdCntW) / $iBbCnt) + ((($iAllW + $iBdCntW) % $iBbCnt)? 1: 0);
+        $iBdCntW = floor($iAllW / $iBbCnt) + (($iAllW % $iBbCnt) ? 1 : 0);
+        $iBdCnt = floor(($iAll + $iBdCntW) / $iBbCnt) + ((($iAllW + $iBdCntW) % $iBbCnt) ? 1 : 0);
         // Calculate BD count
         if ($iBdCnt > $i1stBdL) {
             while (1) {
                 ++$iBdExL;
                 ++$iAllW;
-                $iBdCntW = floor($iAllW / $iBbCnt) + (($iAllW % $iBbCnt)? 1: 0);
-                $iBdCnt = floor(($iAllW + $iBdCntW) / $iBbCnt) + ((($iAllW + $iBdCntW) % $iBbCnt)? 1: 0);
+                $iBdCntW = floor($iAllW / $iBbCnt) + (($iAllW % $iBbCnt) ? 1 : 0);
+                $iBdCnt = floor(($iAllW + $iBdCntW) / $iBbCnt) + ((($iAllW + $iBdCntW) % $iBbCnt) ? 1 : 0);
                 if ($iBdCnt <= ($iBdExL * $iBbCnt + $i1stBdL)) {
                     break;
                 }

src/PhpSpreadsheet/Shared/ZipStreamWrapper.php

Doc Comments +3 added lines, -3 removed lines

@@ -99,7 +99,7 @@ 
     /**
      * Implements support for fstat().
      *
-     * @return  bool
+     * @return  string
      */
     public function statName()
     {
@@ -109,7 +109,7 @@ 
     /**
      * Implements support for fstat().
      *
-     * @return  bool
+     * @return  string
      */
     public function url_stat() // @codingStandardsIgnoreLine
     {
@@ -166,7 +166,7 @@ 
      *
      * @param    int        $offset    byte offset
      * @param    int        $whence    SEEK_SET, SEEK_CUR or SEEK_END
-     * @return    bool
+     * @return    boolean|null
      */
     public function stream_seek($offset, $whence) // @codingStandardsIgnoreLine
     {