nozavroni / csvelte

src/CSVelte/IO/Stream.php

Doc Comments +3 added lines, -3 removed lines

@@ -146,7 +146,7 @@ 
     /**
      * Close stream resource.
      *
-     * @return boolean True on success or false on failure
+     * @return boolean|null True on success or false on failure
      */
     public function close()
     {
@@ -227,7 +227,7 @@ 
      *
      * Returns the internal stream resource pointer
      *
-     * @return resource The open stream resource pointer
+     * @return Resource The open stream resource pointer
      */
     public function getResource()
     {
@@ -265,7 +265,7 @@ 
      *
      * After the stream has been detached, the stream is in an unusable state.
      *
-     * @return Resource|null Underlying PHP stream, if any
+     * @return Resource Underlying PHP stream, if any
      */
     public function detach()
     {

Unused Use Statements -1 removed lines

@@ -19,7 +19,6 @@
 use CSVelte\Contract\Readable;
 use CSVelte\Contract\Writable;
 use CSVelte\Contract\Seekable;
-
 use CSVelte\Exception\NotYetImplementedException;
 
 /**

src/CSVelte/Reader.php

Doc Comments +1 added lines, -1 removed lines

@@ -329,7 +329,7 @@
      * @param string $str The string to unescape
      * @param string $esc The escape character used
      * @param string $quo The quote character used
-     * @return mixed The string with characters unescaped
+     * @return string The string with characters unescaped
      * @todo This actually shouldn't even be necessary. Characters should be read
      *     in one at a time and a quote that follows another should just be ignored
      *     deeming this unnecessary.

Unused Use Statements -2 removed lines

@@ -14,11 +14,9 @@
 namespace CSVelte;
 
 use CSVelte\Contract\Streamable;
-
 use CSVelte\Table\Row;
 use CSVelte\Table\HeaderRow;
 use CSVelte\Reader\FilteredIterator as FilteredReader;
-
 use CSVelte\Exception\EndOfFileException;
 
 use function

src/CSVelte/Taster.php

Doc Comments +1 added lines, -1 removed lines

@@ -562,7 +562,7 @@
      * Determine whether a particular string of data has quotes around it.
      *
      * @param string $data The data to check
-     * @return boolean Whether the data is quoted or not
+     * @return integer Whether the data is quoted or not
      */
     protected function isQuoted($data)
     {

Indentation +25 added lines, -25 removed lines

@@ -292,20 +292,20 @@ 
         throw new TasterException("quoteChar and delimiter cannot be determined", TasterException::ERR_QUOTE_AND_DELIM);
     }
 
-     /**
-      * Take a list of likely delimiter characters and find the one that occurs
-      * the most consistent amount of times within the provided data.
-      *
-      * @param string $eol The character(s) used for newlines
-      * @return string One of four Flavor::QUOTING_* constants
-      * @see Flavor for possible quote style constants
-      * @todo Refactor this method--It needs more thorough testing against a wider
-      *     variety of CSV data to be sure it works reliably. And I'm sure there
-      *     are many performance and logic improvements that could be made. This
-      *     is essentially a first draft.
-      * @todo Can't use replaceQuotedSpecialChars rather than removeQuotedStrings
-      *     because the former requires u to know the delimiter
-      */
+        /**
+         * Take a list of likely delimiter characters and find the one that occurs
+         * the most consistent amount of times within the provided data.
+         *
+         * @param string $eol The character(s) used for newlines
+         * @return string One of four Flavor::QUOTING_* constants
+         * @see Flavor for possible quote style constants
+         * @todo Refactor this method--It needs more thorough testing against a wider
+         *     variety of CSV data to be sure it works reliably. And I'm sure there
+         *     are many performance and logic improvements that could be made. This
+         *     is essentially a first draft.
+         * @todo Can't use replaceQuotedSpecialChars rather than removeQuotedStrings
+         *     because the former requires u to know the delimiter
+         */
     protected function lickDelimiter($eol = "\n")
     {
         $frequencies = [];
@@ -382,16 +382,16 @@ 
              *     which one has the best distribution, return that one.
              */
 
-             $decision = $dups->get($max);
-             try {
-                 return $this->guessDelimByDistribution($decision, $eol);
-             } catch (TasterException $e) {
-                 // if somehow we STILL can't come to a consensus, then fall back to a
-                 // "preferred delimiters" list...
-                 foreach ($this->delims as $key => $val) {
+                $decision = $dups->get($max);
+                try {
+                    return $this->guessDelimByDistribution($decision, $eol);
+                } catch (TasterException $e) {
+                    // if somehow we STILL can't come to a consensus, then fall back to a
+                    // "preferred delimiters" list...
+                    foreach ($this->delims as $key => $val) {
                     if ($delim = array_search($val, $decision)) return $delim;
-                 }
-             }
+                    }
+                }
         }
         return $delims
             ->sort()
@@ -450,8 +450,8 @@ 
             })->map(function($dists) {
                 return $dists->average();
             })->sort()
-              ->reverse()
-              ->getKeyAtPosition(0)];
+                ->reverse()
+                ->getKeyAtPosition(0)];
         } catch (Exception $e) {
             throw new TasterException("delimiter cannot be determined by distribution", TasterException::ERR_DELIMITER);
         }

src/CSVelte/Writer.php

Doc Comments +1 added lines, -1 removed lines

@@ -171,7 +171,7 @@
      * This means taking an array of data, and converting it to a Row object
      *
      * @param \Iterator $row of data items
-     * @return AbstractRow
+     * @return string
      */
     protected function prepareRow(Iterator $row)
     {

Unused Use Statements -1 removed lines

@@ -19,7 +19,6 @@
 use CSVelte\Contract\Readable;
 use CSVelte\Contract\Writable;
 use CSVelte\Contract\Seekable;
-
 use CSVelte\Exception\NotYetImplementedException;
 
 /**