nozavroni / csvelte

src/CSVelte/IO/File.php

Doc Comments +1 added lines, -1 removed lines

@@ -141,7 +141,7 @@
      *
      * @param integer Offset to seek to
      * @param integer Position from whence the offset should be applied
-     * @return boolean True if seek was successful
+     * @return integer True if seek was successful
      * @access public
      */
     public function seek($pos, $whence = SEEK_SET)

Unused Use Statements -2 removed lines

@@ -22,8 +22,6 @@
 use CSVelte\Contract\Writable;
 use CSVelte\Contract\Seekable;
 
-use CSVelte\Exception\NotYetImplementedException;
-
 /**
  * CSVelte File.
  *

src/CSVelte/IO/Stream.php

Doc Comments +3 added lines, -2 removed lines

@@ -145,6 +145,7 @@ 
      *     ``fopen`` function
      * @param array Stream context options array as passed to native php
      *     ``stream_context_create`` function
+     * @param string $mode
      * @see http://php.net/manual/en/function.fopen.php
      * @see http://php.net/manual/en/function.stream-context-create.php
      */
@@ -174,7 +175,7 @@ 
      *     ``fopen`` function)
      * @param array $context Stream context options array as passed to native
      *     php ``stream_context_create`` function
-     * @return stream resource object
+     * @return resource resource object
      * @throws CSVelte\Exception\IOException on invalid stream uri/resource
      * @throws \InvalidArgumentException if context param is not an array
      * @see http://php.net/manual/en/function.fopen.php
@@ -328,7 +329,7 @@ 
      * Reads $length bytes (number of characters) from the stream
      *
      * @param int $length Number of bytes to read from stream
-     * @return string|boolean The data read from stream or false if at end of
+     * @return false|string The data read from stream or false if at end of
      *     file or some other problem.
      * @throws CSVelte\Exception\IOException
      */

Unused Use Statements -3 removed lines

@@ -16,14 +16,11 @@
 use CSVelte\Traits\IsReadable;
 use CSVelte\Traits\IsWritable;
 use CSVelte\Traits\IsSeekable;
-
 use CSVelte\Contract\Readable;
 use CSVelte\Contract\Writable;
 use CSVelte\Contract\Seekable;
 
 use \InvalidArgumentException;
-use CSVelte\Exception\NotYetImplementedException;
-use CSVelte\Exception\EndOfFileException;
 use CSVelte\Exception\IOException;
 
 /**

src/CSVelte/Reader.php

Doc Comments +6 added lines, -2 removed lines

@@ -101,7 +101,7 @@ 
      *
      * Set the ``CSVelte\Flavor`` object, used to determine CSV format.
      *
-     * @param \CSVelte\Flavor|array $flavor Either an array or a flavor object
+     * @param Flavor|null $flavor Either an array or a flavor object
      */
     protected function setFlavor($flavor)
     {
@@ -126,7 +126,7 @@ 
      * readable (can be read). This will make sure that whatever is passed to
      * the reader meets these expectations and set $this->source.
      *
-     * @param \CSVelte\Contract\Readable|object|string $input See description
+     * @param Readable $input See description
      * @return $this
      */
     protected function setSource($input)
@@ -325,6 +325,9 @@ 
      * @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.
+     * @param string $str
+     * @param string $esc
+     * @param string $quo
      */
     protected function unEscape($str, $esc, $quo)
     {
@@ -335,6 +338,7 @@ 
      * Parse a line of CSV data into an array of columns
      *
      * @param string A line of CSV data to parse
+     * @param string $line
      * @return array An array of columns
      * @access protected
      * @internal

src/CSVelte/Taster.php

Doc Comments +6 added lines, -1 removed lines

@@ -165,6 +165,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
      * @access protected
      * @todo Replace code that uses this method with the replaceQuotedSpecialChars
@@ -331,6 +332,7 @@ 
      * @param string The type of quote character being used (single or double)
      * @param string The character used as the column delimiter
      * @param string The character used for newlines
+     * @param string $eol
      * @return string One of four "QUOTING_" constants defined above--see this
      *     method's description for more info.
      * @access protected
@@ -417,7 +419,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
      * @access protected
      */
     protected function isQuoted($data)
@@ -467,6 +469,7 @@ 
      *
      * @param string The string to do the replacements on
      * @param string The delimiter character to replace
+     * @param string $data
      * @return string The data with replacements performed
      * @access protected
      * @todo I could probably pass in (maybe optionally) the newline character I
@@ -493,6 +496,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
      * @access protected
      * @uses \Carbon\Carbon date/time ilbrary/class
@@ -552,6 +556,7 @@ 
      * @param string The CSV data's delimiting char (can be a variety of chars but)
      *     typically is either a comma or a tab, sometimes a pipe)
      * @param string The CSV data's end-of-line char(s) (\n \r or \r\n)
+     * @param string $eol
      * @return boolean True if the data (most likely) contains a header row
      * @access public
      * @todo This method needs a total refactor. It's not necessary to loop twice

src/CSVelte/Writer.php

Doc Comments +5 added lines, -2 removed lines

@@ -90,7 +90,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)
@@ -161,7 +161,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)
@@ -189,6 +189,9 @@ 
         return $this->quoteString($data);
     }
 
+    /**
+     * @param string $str
+     */
     protected function quoteString($str)
     {
         $flvr = $this->getFlavor();