PHPOffice / PhpSpreadsheet

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
     {

src/PhpSpreadsheet/Spreadsheet.php

Doc Comments +11 added lines, -10 removed lines

@@ -136,7 +136,7 @@ 
     /**
      * The workbook has macros ?
      *
-     * @return true if workbook has macros, false if not
+     * @return boolean if workbook has macros, false if not
      */
     public function hasMacros()
     {
@@ -177,7 +177,7 @@ 
     /**
      * Set the macros certificate
      *
-     * @param string|null $Certificate
+     * @param string|null $certificate
      */
     public function setMacrosCertificate($certificate = null)
     {
@@ -230,6 +230,7 @@ 
      * retrieve ribbon XML Data
      *
      * return string|null|array
+     * @return string
      */
     public function getRibbonXMLData($what = 'all') //we need some constants here...
     {
@@ -303,7 +304,7 @@ 
     /**
      * This workbook have a custom UI ?
      *
-     * @return true|false
+     * @return boolean
      */
     public function hasRibbon()
     {
@@ -313,7 +314,7 @@ 
     /**
      * This workbook have additionnal object for the ribbon ?
      *
-     * @return true|false
+     * @return boolean
      */
     public function hasRibbonBinObjects()
     {
@@ -609,7 +610,7 @@ 
      *
      * @param  Worksheet $pSheet
      * @throws Exception
-     * @return Sheet index
+     * @return integer index
      */
     public function getIndex(Worksheet $pSheet)
     {
@@ -628,7 +629,7 @@ 
      * @param  string $sheetName Sheet name to modify index for
      * @param  int $newIndex New index for the sheet
      * @throws Exception
-     * @return New sheet index
+     * @return integer sheet index
      */
     public function setIndexByName($sheetName, $newIndex)
     {
@@ -772,7 +773,7 @@ 
      * Add named range
      *
      * @param  NamedRange $namedRange
-     * @return PhpSpreadsheet
+     * @return boolean
      */
     public function addNamedRange(NamedRange $namedRange)
     {
@@ -818,7 +819,7 @@ 
      *
      * @param  string  $namedRange
      * @param  Worksheet|null  $pSheet  Scope: use null for global scope.
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function removeNamedRange($namedRange, Worksheet $pSheet = null)
     {
@@ -838,7 +839,7 @@ 
     /**
      * Get worksheet iterator
      *
-     * @return WorksheetIterator
+     * @return Worksheet\Iterator
      */
     public function getWorksheetIterator()
     {
@@ -848,7 +849,7 @@ 
     /**
      * Copy workbook (!= clone!)
      *
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function copy()
     {

src/PhpSpreadsheet/Style/Fill.php

Doc Comments +1 added lines, -1 removed lines

@@ -228,7 +228,7 @@
     /**
      * Set Rotation
      *
-     * @param float $pValue
+     * @param integer $pValue
      * @return Fill
      */
     public function setRotation($pValue = 0)

src/PhpSpreadsheet/Style/Font.php

Doc Comments +1 added lines, -1 removed lines

@@ -268,7 +268,7 @@
     /**
      * Set Size
      *
-     * @param float $pValue
+     * @param integer $pValue
      * @return Font
      */
     public function setSize($pValue = 10)

src/PhpSpreadsheet/Worksheet/ColumnDimension.php

Doc Comments +2 added lines, -2 removed lines

@@ -68,7 +68,7 @@ 
     /**
      * Get ColumnIndex
      *
-     * @return string
+     * @return integer
      */
     public function getColumnIndex()
     {
@@ -101,7 +101,7 @@ 
     /**
      * Set Width
      *
-     * @param float $pValue
+     * @param integer $pValue
      * @return ColumnDimension
      */
     public function setWidth($pValue = -1)

src/PhpSpreadsheet/Worksheet/RowDimension.php

Doc Comments +1 added lines, -1 removed lines

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