Fix code style

src/Spout/Common/Creator/HelperFactory.php

@@ -10,8 +10,6 @@ use Box\Spout\Common\Helper\StringHelper;
 /**
  * Class HelperFactory
  * Factory to create helpers
- *
- * @package Box\Spout\Common\Creator
  */
 class HelperFactory
 {

src/Spout/Common/Exception/EncodingConversionException.php

@@ -6,7 +6,6 @@ namespace Box\Spout\Common\Exception;
  * Class EncodingConversionException
  *
  * @api
- * @package Box\Spout\Common\Exception
  */
 class EncodingConversionException extends SpoutException
 {

src/Spout/Common/Exception/IOException.php

@@ -6,7 +6,6 @@ namespace Box\Spout\Common\Exception;
  * Class IOException
  *
  * @api
- * @package Box\Spout\Common\Exception
  */
 class IOException extends SpoutException
 {

src/Spout/Common/Exception/InvalidArgumentException.php

@@ -6,7 +6,6 @@ namespace Box\Spout\Common\Exception;
  * Class InvalidArgumentException
  *
  * @api
- * @package Box\Spout\Common\Exception
  */
 class InvalidArgumentException extends SpoutException
 {

src/Spout/Common/Exception/SpoutException.php

@@ -5,7 +5,6 @@ namespace Box\Spout\Common\Exception;
 /**
  * Class SpoutException
  *
- * @package Box\Spout\Common\Exception
  * @abstract
  */
 abstract class SpoutException extends \Exception

src/Spout/Common/Exception/UnsupportedTypeException.php

@@ -6,7 +6,6 @@ namespace Box\Spout\Common\Exception;
  * Class UnsupportedTypeException
  *
  * @api
- * @package Box\Spout\Common\Exception
  */
 class UnsupportedTypeException extends SpoutException
 {

src/Spout/Common/Helper/EncodingHelper.php

@@ -7,8 +7,6 @@ use Box\Spout\Common\Exception\EncodingConversionException;
 /**
  * Class EncodingHelper
  * This class provides helper functions to work with encodings.
- *
- * @package Box\Spout\Common\Helper
  */
 class EncodingHelper
 {
@@ -97,8 +95,8 @@ class EncodingHelper
      *
      * @param string $string Non UTF-8 string to be converted
      * @param string $sourceEncoding The encoding used to encode the source string
-     * @return string The converted, UTF-8 string
      * @throws \Box\Spout\Common\Exception\EncodingConversionException If conversion is not supported or if the conversion failed
+     * @return string The converted, UTF-8 string
      */
     public function attemptConversionToUTF8($string, $sourceEncoding)
     {
@@ -110,8 +108,8 @@ class EncodingHelper
      *
      * @param string $string UTF-8 string to be converted
      * @param string $targetEncoding The encoding the string should be re-encoded into
-     * @return string The converted string, encoded with the given encoding
      * @throws \Box\Spout\Common\Exception\EncodingConversionException If conversion is not supported or if the conversion failed
+     * @return string The converted string, encoded with the given encoding
      */
     public function attemptConversionFromUTF8($string, $targetEncoding)
     {
@@ -125,8 +123,8 @@ class EncodingHelper
      * @param string $string string to be converted
      * @param string $sourceEncoding The encoding used to encode the source string
      * @param string $targetEncoding The encoding the string should be re-encoded into
-     * @return string The converted string, encoded with the given encoding
      * @throws \Box\Spout\Common\Exception\EncodingConversionException If conversion is not supported or if the conversion failed
+     * @return string The converted string, encoded with the given encoding
      */
     protected function attemptConversion($string, $sourceEncoding, $targetEncoding)
     {
@@ -139,7 +137,7 @@ class EncodingHelper
 
         if ($this->canUseIconv()) {
             $convertedString = $this->globalFunctionsHelper->iconv($string, $sourceEncoding, $targetEncoding);
-        } else if ($this->canUseMbString()) {
+        } elseif ($this->canUseMbString()) {
             $convertedString = $this->globalFunctionsHelper->mb_convert_encoding($string, $sourceEncoding, $targetEncoding);
         } else {
             throw new EncodingConversionException("The conversion from $sourceEncoding to $targetEncoding is not supported. Please install \"iconv\" or \"PHP Intl\".");

src/Spout/Common/Helper/Escaper/CSV.php

@@ -5,8 +5,6 @@ namespace Box\Spout\Common\Helper\Escaper;
 /**
  * Class CSV
  * Provides functions to escape and unescape data for CSV files
- *
- * @package Box\Spout\Common\Helper\Escaper
  */
 class CSV implements EscaperInterface
 {

src/Spout/Common/Helper/Escaper/EscaperInterface.php

@@ -4,8 +4,6 @@ namespace Box\Spout\Common\Helper\Escaper;
 
 /**
  * Interface EscaperInterface
- *
- * @package Box\Spout\Common\Helper\Escaper
  */
 interface EscaperInterface
 {

src/Spout/Common/Helper/Escaper/ODS.php

@@ -5,8 +5,6 @@ namespace Box\Spout\Common\Helper\Escaper;
 /**
  * Class ODS
  * Provides functions to escape and unescape data for ODS files
- *
- * @package Box\Spout\Common\Helper\Escaper
  */
 class ODS implements EscaperInterface
 {

src/Spout/Common/Helper/Escaper/XLSX.php

@@ -5,8 +5,6 @@ namespace Box\Spout\Common\Helper\Escaper;
 /**
  * Class XLSX
  * Provides functions to escape and unescape data for XLSX files
- *
- * @package Box\Spout\Common\Helper\Escaper
  */
 class XLSX implements EscaperInterface
 {
@@ -95,7 +93,7 @@ class XLSX implements EscaperInterface
      * "\t", "\r" and "\n" don't need to be escaped.
      *
      * NOTE: the logic has been adapted from the XlsxWriter library (BSD License)
-     * @link https://github.com/jmcnamara/XlsxWriter/blob/f1e610f29/xlsxwriter/sharedstrings.py#L89
+     * @see https://github.com/jmcnamara/XlsxWriter/blob/f1e610f29/xlsxwriter/sharedstrings.py#L89
      *
      * @return string[]
      */
@@ -108,7 +106,7 @@ class XLSX implements EscaperInterface
             $character = chr($charValue);
             if (preg_match("/{$this->escapableControlCharactersPattern}/", $character)) {
                 $charHexValue = dechex($charValue);
-                $escapedChar = '_x' . sprintf('%04s' , strtoupper($charHexValue)) . '_';
+                $escapedChar = '_x' . sprintf('%04s', strtoupper($charHexValue)) . '_';
                 $controlCharactersEscapingMap[$escapedChar] = $character;
             }
         }
@@ -124,7 +122,7 @@ class XLSX implements EscaperInterface
      * So "\0" -> _x0000_ and "_x0000_" -> _x005F_x0000_.
      *
      * NOTE: the logic has been adapted from the XlsxWriter library (BSD License)
-     * @link https://github.com/jmcnamara/XlsxWriter/blob/f1e610f29/xlsxwriter/sharedstrings.py#L89
+     * @see https://github.com/jmcnamara/XlsxWriter/blob/f1e610f29/xlsxwriter/sharedstrings.py#L89
      *
      * @param string $string String to escape
      * @return string
@@ -138,7 +136,7 @@ class XLSX implements EscaperInterface
             return $escapedString;
         }
 
-        return preg_replace_callback("/({$this->escapableControlCharactersPattern})/", function($matches) {
+        return preg_replace_callback("/({$this->escapableControlCharactersPattern})/", function ($matches) {
             return $this->controlCharactersEscapingReverseMap[$matches[0]];
         }, $escapedString);
     }
@@ -162,7 +160,7 @@ class XLSX implements EscaperInterface
      * So "_x0000_" -> "\0" and "_x005F_x0000_" -> "_x0000_"
      *
      * NOTE: the logic has been adapted from the XlsxWriter library (BSD License)
-     * @link https://github.com/jmcnamara/XlsxWriter/blob/f1e610f29/xlsxwriter/sharedstrings.py#L89
+     * @see https://github.com/jmcnamara/XlsxWriter/blob/f1e610f29/xlsxwriter/sharedstrings.py#L89
      *
      * @param string $string String to unescape
      * @return string

src/Spout/Common/Helper/FileSystemHelper.php

@@ -8,8 +8,6 @@ use Box\Spout\Common\Exception\IOException;
  * Class FileSystemHelper
  * This class provides helper functions to help with the file system operations
  * like files/folders creation & deletion
- *
- * @package Box\Spout\Common\Helper
  */
 class FileSystemHelper implements FileSystemHelperInterface
 {
@@ -29,8 +27,8 @@ class FileSystemHelper implements FileSystemHelperInterface
      *
      * @param string $parentFolderPath The parent folder path under which the folder is going to be created
      * @param string $folderName The name of the folder to create
-     * @return string Path of the created folder
      * @throws \Box\Spout\Common\Exception\IOException If unable to create the folder or if the folder path is not inside of the base folder
+     * @return string Path of the created folder
      */
     public function createFolder($parentFolderPath, $folderName)
     {
@@ -53,8 +51,8 @@ class FileSystemHelper implements FileSystemHelperInterface
      * @param string $parentFolderPath The parent folder path where the file is going to be created
      * @param string $fileName The name of the file to create
      * @param string $fileContents The contents of the file to create
-     * @return string Path of the created file
      * @throws \Box\Spout\Common\Exception\IOException If unable to create the file or if the file path is not inside of the base folder
+     * @return string Path of the created file
      */
     public function createFileWithContents($parentFolderPath, $fileName, $fileContents)
     {
@@ -74,8 +72,8 @@ class FileSystemHelper implements FileSystemHelperInterface
      * Delete the file at the given path
      *
      * @param string $filePath Path of the file to delete
-     * @return void
      * @throws \Box\Spout\Common\Exception\IOException If the file path is not inside of the base folder
+     * @return void
      */
     public function deleteFile($filePath)
     {
@@ -90,8 +88,8 @@ class FileSystemHelper implements FileSystemHelperInterface
      * Delete the folder at the given path as well as all its contents
      *
      * @param string $folderPath Path of the folder to delete
-     * @return void
      * @throws \Box\Spout\Common\Exception\IOException If the folder path is not inside of the base folder
+     * @return void
      */
     public function deleteFolderRecursively($folderPath)
     {
@@ -119,8 +117,8 @@ class FileSystemHelper implements FileSystemHelperInterface
      * should occur is not inside the base folder.
      *
      * @param string $operationFolderPath The path of the folder where the I/O operation should occur
-     * @return void
      * @throws \Box\Spout\Common\Exception\IOException If the folder where the I/O operation should occur is not inside the base folder
+     * @return void
      */
     protected function throwIfOperationNotInBaseFolder($operationFolderPath)
     {

src/Spout/Common/Helper/FileSystemHelperInterface.php

@@ -6,8 +6,6 @@ namespace Box\Spout\Common\Helper;
  * Class FileSystemHelperInterface
  * This interface describes helper functions to help with the file system operations
  * like files/folders creation & deletion
- *
- * @package Box\Spout\Common\Helper
  */
 interface FileSystemHelperInterface
 {
@@ -16,8 +14,8 @@ interface FileSystemHelperInterface
      *
      * @param string $parentFolderPath The parent folder path under which the folder is going to be created
      * @param string $folderName The name of the folder to create
-     * @return string Path of the created folder
      * @throws \Box\Spout\Common\Exception\IOException If unable to create the folder or if the folder path is not inside of the base folder
+     * @return string Path of the created folder
      */
     public function createFolder($parentFolderPath, $folderName);
 
@@ -28,8 +26,8 @@ interface FileSystemHelperInterface
      * @param string $parentFolderPath The parent folder path where the file is going to be created
      * @param string $fileName The name of the file to create
      * @param string $fileContents The contents of the file to create
-     * @return string Path of the created file
      * @throws \Box\Spout\Common\Exception\IOException If unable to create the file or if the file path is not inside of the base folder
+     * @return string Path of the created file
      */
     public function createFileWithContents($parentFolderPath, $fileName, $fileContents);
 
@@ -37,8 +35,8 @@ interface FileSystemHelperInterface
      * Delete the file at the given path
      *
      * @param string $filePath Path of the file to delete
-     * @return void
      * @throws \Box\Spout\Common\Exception\IOException If the file path is not inside of the base folder
+     * @return void
      */
     public function deleteFile($filePath);
 
@@ -46,8 +44,8 @@ interface FileSystemHelperInterface
      * Delete the folder at the given path as well as all its contents
      *
      * @param string $folderPath Path of the folder to delete
-     * @return void
      * @throws \Box\Spout\Common\Exception\IOException If the folder path is not inside of the base folder
+     * @return void
      */
     public function deleteFolderRecursively($folderPath);
 }

src/Spout/Common/Helper/GlobalFunctionsHelper.php

@@ -7,8 +7,6 @@ namespace Box\Spout\Common\Helper;
  * This class wraps global functions to facilitate testing
  *
  * @codeCoverageIgnore
- *
- * @package Box\Spout\Common\Helper
  */
 class GlobalFunctionsHelper
 {
@@ -165,6 +163,7 @@ class GlobalFunctionsHelper
     public function file_get_contents($filePath)
     {
         $realFilePath = $this->convertToUseRealPath($filePath);
+
         return file_get_contents($realFilePath);
     }
 

src/Spout/Common/Helper/StringHelper.php

@@ -7,8 +7,6 @@ namespace Box\Spout\Common\Helper;
  * This class provides helper functions to work with strings and multibyte strings.
  *
  * @codeCoverageIgnore
- *
- * @package Box\Spout\Common\Helper
  */
 class StringHelper
 {
@@ -50,6 +48,7 @@ class StringHelper
     public function getCharFirstOccurrencePosition($char, $string)
     {
         $position = $this->hasMbstringSupport ? mb_strpos($string, $char) : strpos($string, $char);
+
         return ($position !== false) ? $position : -1;
     }
 
@@ -66,6 +65,7 @@ class StringHelper
     public function getCharLastOccurrencePosition($char, $string)
     {
         $position = $this->hasMbstringSupport ? mb_strrpos($string, $char) : strrpos($string, $char);
+
         return ($position !== false) ? $position : -1;
     }
 }

src/Spout/Common/Manager/OptionsManagerAbstract.php

@@ -4,8 +4,6 @@ namespace Box\Spout\Common\Manager;
 
 /**
  * Class OptionsManager
- *
- * @package Box\Spout\Common\Manager
  */
 abstract class OptionsManagerAbstract implements OptionsManagerInterface
 {

src/Spout/Common/Manager/OptionsManagerInterface.php

@@ -4,8 +4,6 @@ namespace Box\Spout\Common\Manager;
 
 /**
  * Interface OptionsManagerInterface
- *
- * @package Box\Spout\Common\Manager
  */
 interface OptionsManagerInterface
 {