PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Reader/Xls.php

Doc Comments +5 added lines, -5 removed lines

@@ -5157,7 +5157,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()
     {
@@ -5421,7 +5421,7 @@ 
      * @param string $formulaData Formula data
      * @param string $baseCell Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
      * @throws Exception
-     * @return array
+     * @return string
      */
     private function getNextToken($formulaData, $baseCell = 'A1')
     {
@@ -6989,7 +6989,7 @@ 
      * section 2.5.15
      *
      * @param string $subData
-     * @return array
+     * @return string
      */
     private function readBIFF8CellRangeAddressList($subData)
     {
@@ -7100,7 +7100,7 @@ 
      * section 2.5.8
      *
      * @param string $arrayData
-     * @return array
+     * @return string
      */
     private static function readBIFF8ConstantArray($arrayData)
     {
@@ -7138,7 +7138,7 @@ 
      * returns e.g. array('value' => '5', 'size' => 9)
      *
      * @param string $valueData
-     * @return array
+     * @return string
      */
     private static function readBIFF8Constant($valueData)
     {

src/PhpSpreadsheet/Reader/Xls/MD5.php

Doc Comments +5 added lines

@@ -190,6 +190,11 @@
         return ($Y ^ ($X | (~ $Z))) ; // Y XOR (X OR NOT Z)
     }
 
+    /**
+     * @param string[] $func
+     * @param integer $s
+     * @param integer $t
+     */
     private static function step($func, &$A, $B, $C, $D, $M, $s, $t)
     {
         $A = ($A + call_user_func($func, $B, $C, $D) + $M + $t) & 0xffffffff;

src/PhpSpreadsheet/Writer/Xls/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/Xls/Workbook.php

Doc Comments +2 added lines, -1 removed lines

@@ -233,6 +233,7 @@ 
      *
      * @param \PhpOffice\PhpSpreadsheet\Style
      * @param bool Is it a style XF?
+     * @param \PhpOffice\PhpSpreadsheet\Style $style
      * @return int Index to XF record
      */
     public function addXfWriter($style, $isStyleXf = false)
@@ -783,7 +784,7 @@ 
      *
      * @param    string        $name            The name in UTF-8
      * @param    string        $formulaData    The binary formula data
-     * @param    string        $sheetIndex        1-based sheet index the defined name applies to. 0 = global
+     * @param    integer        $sheetIndex        1-based sheet index the defined name applies to. 0 = global
      * @param    bool        $isBuiltIn        Built-in name?
      * @return    string    Complete binary record data
      */

src/PhpSpreadsheet/Writer/Xls/Worksheet.php

Doc Comments +9 added lines, -7 removed lines

@@ -199,10 +199,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 \PhpSpreadsheet\Worksheet $phpSheet
+     * @param integer $str_total
+     * @param integer $str_unique
      */
     public function __construct(&$str_total, &$str_unique, &$str_table, &$colors, $parser, $preCalculateFormulas, $phpSheet)
     {
@@ -611,7 +613,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
      */
     private function writeNumber($row, $col, $num, $xfIndex)
@@ -717,7 +719,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
      */
     private function writeLabelSst($row, $col, $str, $xfIndex)
@@ -783,7 +785,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)
     {
@@ -830,7 +832,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
      */
@@ -2299,8 +2301,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)
     {

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     .

src/PhpSpreadsheet/Writer/Xls/Font.php

Spacing +5 added lines, -5 removed lines

@@ -85,9 +85,9 @@ 
         $bFamily = 0; // Font family
         $bCharSet = \PHPExcel\Shared\Font::getCharsetFromFontName($this->font->getName()); // Character set
 
-        $record = 0x31;        // Record identifier
-        $reserved = 0x00;    // Reserved
-        $grbit = 0x00;        // Font attributes
+        $record = 0x31; // Record identifier
+        $reserved = 0x00; // Reserved
+        $grbit = 0x00; // Font attributes
         if ($this->font->getItalic()) {
             $grbit |= 0x02;
         }
@@ -134,9 +134,9 @@ 
     private static function mapBold($bold)
     {
         if ($bold) {
-            return 0x2BC;  //  700 = Bold font weight
+            return 0x2BC; //  700 = Bold font weight
         }
-        return 0x190;      //  400 = Normal font weight
+        return 0x190; //  400 = Normal font weight
     }
 
     /**

src/PhpSpreadsheet/Reader/HTML.php

Doc Comments +13 added lines

@@ -168,16 +168,25 @@ 
         return fread($this->fileHandle, $blockSize);
     }
 
+    /**
+     * @param string $data
+     */
     private static function startsWithTag($data)
     {
         return '<' === substr(trim($data), 0, 1);
     }
 
+    /**
+     * @param string $data
+     */
     private static function endsWithTag($data)
     {
         return '>' === substr(trim($data), -1, 1);
     }
 
+    /**
+     * @param string $data
+     */
     private static function containsTags($data)
     {
         return strlen($data) !== strlen(strip_tags($data));
@@ -249,6 +258,10 @@ 
         return array_pop($this->nestedColumn);
     }
 
+    /**
+     * @param \PhpOffice\PhpSpreadsheet\Worksheet $sheet
+     * @param integer $row
+     */
     protected function flushCell($sheet, $column, $row, &$cellContent)
     {
         if (is_string($cellContent)) {

docs/Examples/index.php

Spacing +2 added lines, -2 removed lines

@@ -34,10 +34,10 @@
             $h1Text = $out[1];
             $h2Text = (preg_match($h2Pattern, $fileData, $out)) ? $out[1] : '';
 
-            echo '<a href="',$exampleFile,'">',$h1Text,'</a><br />';
+            echo '<a href="', $exampleFile, '">', $h1Text, '</a><br />';
             if (($h2Text > '') &&
                 (pathinfo($exampleType, PATHINFO_BASENAME) != 'Calculations')) {
-                echo $h2Text,'<br />';
+                echo $h2Text, '<br />';
             }
         }
     }

docs/Examples/Reading WorkBook Data/exampleWorkBookReader03.php

Spacing +2 added lines, -2 removed lines

@@ -41,7 +41,7 @@ 
 echo '<b>Custom Properties: </b><br />';
 /*  Loop through the list of custom properties  **/
 foreach ($customPropertyList as $customPropertyName) {
-    echo '<b>',$customPropertyName,': </b>';
+    echo '<b>', $customPropertyName, ': </b>';
     /*  Retrieve the property value  **/
     $propertyValue = $objPHPExcel->getProperties()->getCustomPropertyValue($customPropertyName);
     /*  Retrieve the property type  **/
@@ -68,7 +68,7 @@ 
             break;
     }
 
-    echo $propertyValue,' (',$propertyType,')<br />';
+    echo $propertyValue, ' (', $propertyType, ')<br />';
 }
 
 ?>