Minor improvements (#1029)

* Another collection of minor improvements

* Fix broken test

* And style

* Seriously?!? The order of returned types declared in a docblock is majorly important?

Author: Mark Baker

src/PhpSpreadsheet/Cell/Cell.php

@@ -523,7 +523,7 @@ public function isMergeRangeValueCell()
     /**
      * If this cell is in a merge range, then return the range.
      *
-     * @return string
+     * @return false|string
      */
     public function getMergeRange()
     {

src/PhpSpreadsheet/Cell/Coordinate.php

@@ -157,14 +157,12 @@ public static function buildRange(array $pRange)
         }
 
         // Build range
-        $imploded = [];
         $counter = count($pRange);
         for ($i = 0; $i < $counter; ++$i) {
             $pRange[$i] = implode(':', $pRange[$i]);
         }
-        $imploded = implode(',', $pRange);
 
-        return $imploded;
+        return implode(',', $pRange);
     }
 
     /**

src/PhpSpreadsheet/Collection/Cells.php

@@ -241,7 +241,7 @@ public function getCurrentRow()
      */
     public function getHighestColumn($row = null)
     {
-        if ($row == null) {
+        if ($row === null) {
             $colRow = $this->getHighestRowAndColumn();
 
             return $colRow['column'];
@@ -272,7 +272,7 @@ public function getHighestColumn($row = null)
      */
     public function getHighestRow($column = null)
     {
-        if ($column == null) {
+        if ($column === null) {
             $colRow = $this->getHighestRowAndColumn();
 
             return $colRow['row'];

src/PhpSpreadsheet/Reader/Csv.php

@@ -143,7 +143,7 @@ protected function checkSeparator()
             return;
         }
 
-        return $this->skipBOM();
+        $this->skipBOM();
     }
 
     /**
@@ -184,8 +184,9 @@ protected function inferSeparator()
         // If number of lines is 0, nothing to infer : fall back to the default
         if ($numberLines === 0) {
             $this->delimiter = reset($potentialDelimiters);
+            $this->skipBOM();
 
-            return $this->skipBOM();
+            return;
         }
 
         // Calculate the mean square deviations for each delimiter (ignoring delimiters that haven't been found consistently)
@@ -230,7 +231,7 @@ function ($sum, $value) use ($median) {
             $this->delimiter = reset($potentialDelimiters);
         }
 
-        return $this->skipBOM();
+        $this->skipBOM();
     }
 
     /**

src/PhpSpreadsheet/Reader/Ods.php

@@ -52,7 +52,7 @@ public function canRead($pFilename)
             $stat = $zip->statName('mimetype');
             if ($stat && ($stat['size'] <= 255)) {
                 $mimeType = $zip->getFromName($stat['name']);
-            } elseif ($stat = $zip->statName('META-INF/manifest.xml')) {
+            } elseif ($zip->statName('META-INF/manifest.xml')) {
                 $xml = simplexml_load_string(
                     $this->securityScanner->scan($zip->getFromName('META-INF/manifest.xml')),
                     'SimpleXMLElement',
@@ -513,7 +513,7 @@ public function loadIntoExisting($pFilename, Spreadsheet $spreadsheet)
                                     foreach ($paragraphs as $pData) {
                                         $dataArray[] = $this->scanElementForText($pData);
                                     }
-                                    $allCellDataText = implode($dataArray, "\n");
+                                    $allCellDataText = implode("\n", $dataArray);
 
                                     $type = $cellData->getAttributeNS($officeNs, 'value-type');
 
@@ -580,12 +580,12 @@ public function loadIntoExisting($pFilename, Spreadsheet $spreadsheet)
                                             );
 
                                             $dataValue = Date::formattedPHPToExcel(
-                                                $year,
-                                                $month,
-                                                $day,
-                                                $hour,
-                                                $minute,
-                                                $second
+                                                (int) $year,
+                                                (int) $month,
+                                                (int) $day,
+                                                (int) $hour,
+                                                (int) $minute,
+                                                (int) $second
                                             );
 
                                             if ($dataValue != floor($dataValue)) {

src/PhpSpreadsheet/ReferenceHelper.php

@@ -82,13 +82,10 @@ public static function columnReverseSort($a, $b)
      */
     public static function cellSort($a, $b)
     {
-        $ac = $bc = '';
-        $ar = $br = 0;
-
         sscanf($a, '%[A-Z]%d', $ac, $ar);
         sscanf($b, '%[A-Z]%d', $bc, $br);
 
-        if ($ar == $br) {
+        if ($ar === $br) {
             return strcasecmp(strlen($ac) . $ac, strlen($bc) . $bc);
         }
 
@@ -106,13 +103,10 @@ public static function cellSort($a, $b)
      */
     public static function cellReverseSort($a, $b)
     {
-        $ac = $bc = '';
-        $ar = $br = 0;
-
         sscanf($a, '%[A-Z]%d', $ac, $ar);
         sscanf($b, '%[A-Z]%d', $bc, $br);
 
-        if ($ar == $br) {
+        if ($ar === $br) {
             return 1 - strcasecmp(strlen($ac) . $ac, strlen($bc) . $bc);
         }
 
@@ -625,7 +619,7 @@ public function insertNewBefore($pBefore, $pNumCols, $pNumRows, Worksheet $pShee
      * Update references within formulas.
      *
      * @param string $pFormula Formula to update
-     * @param int $pBefore Insert before this one
+     * @param string $pBefore Insert before this one
      * @param int $pNumCols Number of columns to insert
      * @param int $pNumRows Number of rows to insert
      * @param string $sheetName Worksheet name/title

src/PhpSpreadsheet/Writer/BaseWriter.php

@@ -35,85 +35,35 @@ abstract class BaseWriter implements IWriter
      */
     private $diskCachingDirectory = './';
 
-    /**
-     * Write charts in workbook?
-     *        If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object.
-     *        If false (the default) it will ignore any charts defined in the PhpSpreadsheet object.
-     *
-     * @return bool
-     */
     public function getIncludeCharts()
     {
         return $this->includeCharts;
     }
 
-    /**
-     * Set write charts in workbook
-     *        Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object.
-     *        Set to false (the default) to ignore charts.
-     *
-     * @param bool $pValue
-     *
-     * @return IWriter
-     */
     public function setIncludeCharts($pValue)
     {
         $this->includeCharts = (bool) $pValue;
 
         return $this;
     }
 
-    /**
-     * Get Pre-Calculate Formulas flag
-     *     If this is true (the default), then the writer will recalculate all formulae in a workbook when saving,
-     *        so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet
-     *        viewer when opening the file
-     *     If false, then formulae are not calculated on save. This is faster for saving in PhpSpreadsheet, but slower
-     *        when opening the resulting file in MS Excel, because Excel has to recalculate the formulae itself.
-     *
-     * @return bool
-     */
     public function getPreCalculateFormulas()
     {
         return $this->preCalculateFormulas;
     }
 
-    /**
-     * Set Pre-Calculate Formulas
-     *        Set to true (the default) to advise the Writer to calculate all formulae on save
-     *        Set to false to prevent precalculation of formulae on save.
-     *
-     * @param bool $pValue Pre-Calculate Formulas?
-     *
-     * @return IWriter
-     */
     public function setPreCalculateFormulas($pValue)
     {
         $this->preCalculateFormulas = (bool) $pValue;
 
         return $this;
     }
 
-    /**
-     * Get use disk caching where possible?
-     *
-     * @return bool
-     */
     public function getUseDiskCaching()
     {
         return $this->useDiskCaching;
     }
 
-    /**
-     * Set use disk caching where possible?
-     *
-     * @param bool $pValue
-     * @param string $pDirectory Disk caching directory
-     *
-     * @throws Exception when directory does not exist
-     *
-     * @return IWriter
-     */
     public function setUseDiskCaching($pValue, $pDirectory = null)
     {
         $this->useDiskCaching = $pValue;
@@ -129,11 +79,6 @@ public function setUseDiskCaching($pValue, $pDirectory = null)
         return $this;
     }
 
-    /**
-     * Get disk caching directory.
-     *
-     * @return string
-     */
     public function getDiskCachingDirectory()
     {
         return $this->diskCachingDirectory;

src/PhpSpreadsheet/Writer/IWriter.php

@@ -13,6 +13,49 @@ interface IWriter
      */
     public function __construct(Spreadsheet $spreadsheet);
 
+    /**
+     * Write charts in workbook?
+     *        If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object.
+     *        If false (the default) it will ignore any charts defined in the PhpSpreadsheet object.
+     *
+     * @return bool
+     */
+    public function getIncludeCharts();
+
+    /**
+     * Set write charts in workbook
+     *        Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object.
+     *        Set to false (the default) to ignore charts.
+     *
+     * @param bool $pValue
+     *
+     * @return IWriter
+     */
+    public function setIncludeCharts($pValue);
+
+    /**
+     * Get Pre-Calculate Formulas flag
+     *     If this is true (the default), then the writer will recalculate all formulae in a workbook when saving,
+     *        so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet
+     *        viewer when opening the file
+     *     If false, then formulae are not calculated on save. This is faster for saving in PhpSpreadsheet, but slower
+     *        when opening the resulting file in MS Excel, because Excel has to recalculate the formulae itself.
+     *
+     * @return bool
+     */
+    public function getPreCalculateFormulas();
+
+    /**
+     * Set Pre-Calculate Formulas
+     *        Set to true (the default) to advise the Writer to calculate all formulae on save
+     *        Set to false to prevent precalculation of formulae on save.
+     *
+     * @param bool $pValue Pre-Calculate Formulas?
+     *
+     * @return IWriter
+     */
+    public function setPreCalculateFormulas($pValue);
+
     /**
      * Save PhpSpreadsheet to file.
      *
@@ -21,4 +64,30 @@ public function __construct(Spreadsheet $spreadsheet);
      * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
      */
     public function save($pFilename);
+
+    /**
+     * Get use disk caching where possible?
+     *
+     * @return bool
+     */
+    public function getUseDiskCaching();
+
+    /**
+     * Set use disk caching where possible?
+     *
+     * @param bool $pValue
+     * @param string $pDirectory Disk caching directory
+     *
+     * @throws Exception when directory does not exist
+     *
+     * @return IWriter
+     */
+    public function setUseDiskCaching($pValue, $pDirectory = null);
+
+    /**
+     * Get disk caching directory.
+     *
+     * @return string
+     */
+    public function getDiskCachingDirectory();
 }