nozavroni / csvelte

src/CSVelte/IO/Resource.php

Doc Comments +4 added lines, -1 removed lines

@@ -219,7 +219,7 @@ 
      *
      * Creates and returns a Stream object for this resource
      *
-     * @return resource The underlying stream resource
+     * @return Stream The underlying stream resource
      */
     public function __invoke()
     {
@@ -432,6 +432,7 @@ 
      * until the user specifically requests it.
      *
      * @param boolean|null Whether or not to "lazily" open the stream
+     * @param boolean|null $lazy
      * @return $this
      */
     protected function setLazy($lazy)
@@ -841,6 +842,7 @@ 
      * only be called on unopened stream resources.
      *
      * @param  string The method that is asserting
+     * @param string $method
      * @return void
      * @throws \CSVelte\Exception\IOException if stream is open
      */
@@ -857,6 +859,7 @@ 
      * Used internally to ensure that a given stream wrapper is valid and available
      *
      * @param  string The name of the stream wrapper
+     * @param string $name
      * @return void
      * @throws \InvalidArgumentException if wrapper doesn't exist
      */

Indentation +8 added lines, -8 removed lines

@@ -190,17 +190,17 @@ 
             // set all this manually
             $meta = stream_get_meta_data($handle);
             $this->setUri($meta['uri'])
-                 ->setMode($meta['mode']);
+                    ->setMode($meta['mode']);
             $this->conn = $handle;
             return;
         }
 
         // ok we're opening a new stream resource handle
         $this->setUri($uri)
-             ->setMode($mode)
-             ->setLazy($lazy)
-             ->setUseIncludePath($use_include_path)
-             ->setContext($context_options, $context_params);
+                ->setMode($mode)
+                ->setLazy($lazy)
+                ->setUseIncludePath($use_include_path)
+                ->setContext($context_options, $context_params);
         if (!$this->isLazy()) {
             $this->connect();
         }
@@ -339,9 +339,9 @@ 
 
         $this->flag = '';
         $this->setBaseMode($base)
-             ->setIsPlus($plus == '+')
-             ->setIsText($flag == 't')
-             ->setIsBinary($flag == 'b');
+                ->setIsPlus($plus == '+')
+                ->setIsText($flag == 't')
+                ->setIsBinary($flag == 'b');
 
         return $this;
     }

src/CSVelte/IO/Stream.php

Doc Comments +4 added lines, -3 removed lines

@@ -131,6 +131,7 @@ 
      *
      * @see http://php.net/manual/en/function.fopen.php
      * @see http://php.net/manual/en/function.stream-context-create.php
+     * @param string $mode
      */
     public static function open($uri, $mode = null, $context = null, $lazy = false)
     {
@@ -143,7 +144,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()
     {
@@ -224,7 +225,7 @@ 
      *
      * Returns the internal stream resource pointer
      *
-     * @return resource The open stream resource pointer
+     * @return Resource The open stream resource pointer
      */
     public function getResource()
     {
@@ -262,7 +263,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()
     {

src/CSVelte/Taster.php

Doc Comments +5 added lines, -1 removed lines

@@ -189,6 +189,7 @@ 
      * replaceQuotedSpecialChars method which (at least to me) makes more sense.
      *
      * @param string The string to replace quoted strings within
+     * @param string $data
      * @return string The input string with quoted strings removed
      * @todo Replace code that uses this method with the replaceQuotedSpecialChars
      *     method instead. I think it's cleaner.
@@ -559,7 +560,7 @@ 
      * Determine whether a particular string of data has quotes around it.
      *
      * @param string 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)
     {
@@ -607,6 +608,8 @@ 
      *
      * @param string The string to do the replacements on
      * @param string The delimiter character to replace
+     * @param string $data
+     * @param string $delim
      * @return string The data with replacements performed
      * @todo I could probably pass in (maybe optionally) the newline character I
      *     want to replace as well. I'll do that if I need to.
@@ -632,6 +635,7 @@ 
      * to be practical.
      *
      * @param string The string of data to check the type of
+     * @param string $data
      * @return string One of the TYPE_ string constants above
      */
     protected function lickType($data)

Indentation +25 added lines, -25 removed lines

@@ -290,20 +290,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 The character(s) used for newlines
-      * @return string One of four Flavor::QUOTING_* constants
-      * @see \CSVelte\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 The character(s) used for newlines
+         * @return string One of four Flavor::QUOTING_* constants
+         * @see \CSVelte\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 = [];
@@ -380,16 +380,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()
@@ -446,8 +446,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 +6 added lines, -3 removed lines

@@ -60,7 +60,7 @@ 
     /**
      * Class Constructor
      *
-     * @param \CSVelte\Contract\Writable $output An output source to write to
+     * @param Streamable $output An output source to write to
      * @param \CSVelte\Flavor|array $flavor A flavor or set of formatting params
      */
     public function __construct(Streamable $output, $flavor = null)
@@ -89,7 +89,7 @@ 
      * likely buffer the output so that this may be called after writeRows()
      *
      * @param \Iterator|array A list of header values
-     * @return boolean
+     * @return boolean|null
      * @throws \CSVelte\Exception\WriterException
      */
     public function setHeaderRow($headers)
@@ -159,7 +159,7 @@ 
      * This means taking an array of data, and converting it to a Row object
      *
      * @param \Iterator|array of data items
-     * @return CSVelte\Table\AbstractRow
+     * @return Row
      * @access protected
      */
     protected function prepareRow(Iterator $row)
@@ -187,6 +187,9 @@ 
         return $this->quoteString($data);
     }
 
+    /**
+     * @param string $str
+     */
     protected function quoteString($str)
     {
         $flvr = $this->getFlavor();

src/CSVelte/Table/AbstractRow.php

Indentation +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
     public function __construct($fields)
     {
         $this->setFields($fields)
-             ->rewind();
+                ->rewind();
     }
 
     protected function setFields($fields)

Doc Comments +3 added lines, -3 removed lines

@@ -132,7 +132,7 @@ 
     /**
      * Get the current key (column number or header, if available)
      *
-     * @return string The "current" key
+     * @return integer The "current" key
      * @access public
      * @todo Figure out if this can return a CSVelte\Table\HeaderData object so long as it
      *     has a __toString() method that generated the right key...
@@ -146,7 +146,7 @@ 
      * Advance the internal pointer to the next column's data object
      * Also returns the next column's data object if there is one
      *
-     * @return CSVelte\Table\Data The "next" column's data
+     * @return string|null The "next" column's data
      * @access public
      */
     public function next()
@@ -158,7 +158,7 @@ 
     /**
      * Return the internal pointer to the first column and return that object
      *
-     * @return null|AbstractRow
+     * @return string|null
      */
     public function rewind()
     {

src/CSVelte/Reader.php

Indentation +2 added lines, -2 removed lines

@@ -91,8 +91,8 @@
     public function __construct($input, $flavor = null)
     {
         $this->setSource($input)
-             ->setFlavor($flavor)
-             ->rewind();
+                ->setFlavor($flavor)
+                ->rewind();
     }
 
     /**

src/CSVelte/Exception/HeaderException.php

Indentation -1 removed lines

@@ -19,7 +19,6 @@
 if (if $file->hasHeader()) {
     $header = $file->getHeader()
 }
-
  * you can instead simply call $header->getHeader() and handle this exception if
  * said file has no header
  *

src/CSVelte/IO/BufferStream.php

Indentation +10 added lines, -10 removed lines

@@ -267,16 +267,16 @@
         return strlen($data);
     }
 
-     /**
-      * Seekability accessor.
-      *
-      * Despite the fact that any class that implements this interface must also
-      * define methods such as seek, that is no guarantee that an
-      * object will necessarily be seekable. This method should tell the user
-      * whether a stream is, in fact, seekable.
-      *
-      * @return boolean True if seekable, false otherwise
-      */
+        /**
+         * Seekability accessor.
+         *
+         * Despite the fact that any class that implements this interface must also
+         * define methods such as seek, that is no guarantee that an
+         * object will necessarily be seekable. This method should tell the user
+         * whether a stream is, in fact, seekable.
+         *
+         * @return boolean True if seekable, false otherwise
+         */
     public function isSeekable()
     {
         return $this->seekable;

Doc Comments +2 added lines, -2 removed lines

@@ -119,7 +119,7 @@ 
      * Read in the specified amount of characters from the input source
      *
      * @param integer Amount of characters to read from input source
-     * @return string|boolean The specified amount of characters read from input source
+     * @return false|string The specified amount of characters read from input source
      */
     public function read($chars)
     {
@@ -246,7 +246,7 @@ 
      *
      * After the stream has been detached, the stream is in an unusable state.
      *
-     * @return BufferStream|null Underlying PHP stream, if any
+     * @return string Underlying PHP stream, if any
      */
     public function detach()
     {

src/CSVelte/Contract/Streamable.php

Indentation +10 added lines, -10 removed lines

@@ -267,16 +267,16 @@
         return strlen($data);
     }
 
-     /**
-      * Seekability accessor.
-      *
-      * Despite the fact that any class that implements this interface must also
-      * define methods such as seek, that is no guarantee that an
-      * object will necessarily be seekable. This method should tell the user
-      * whether a stream is, in fact, seekable.
-      *
-      * @return boolean True if seekable, false otherwise
-      */
+        /**
+         * Seekability accessor.
+         *
+         * Despite the fact that any class that implements this interface must also
+         * define methods such as seek, that is no guarantee that an
+         * object will necessarily be seekable. This method should tell the user
+         * whether a stream is, in fact, seekable.
+         *
+         * @return boolean True if seekable, false otherwise
+         */
     public function isSeekable()
     {
         return $this->seekable;