nozavroni / csvelte

src/CSVelte/Writer.php

Doc Comments +3 added lines, -3 removed lines

@@ -86,7 +86,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\WriteBufferException
      */
     public function setHeaderRow($headers)
@@ -152,7 +152,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)
@@ -169,7 +169,7 @@ 
      * Prepare a cell of data to be written (convert to Data object)
      *
      * @param mixed Any value that can be converted to a CSVelte\Table\Data object
-     * @return CSVelte\Table\Data
+     * @return string
      * @access protected
      */
     protected function prepareData($data)

src/CSVelte/IO/File.php

Doc Comments +3 added lines, -1 removed lines

@@ -48,6 +48,7 @@ 
      * Read in the specified amount of characters from the file
      *
      * @param integer Amount of characters to read from file
+     * @param integer $length
      * @return string The specified amount of characters read from file
      * @access public
      */
@@ -72,6 +73,7 @@ 
      * Write data to the output
      *
      * @param string The data to write
+     * @param string $data
      * @return int The number of bytes written
      * @access public
      */
@@ -97,7 +99,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 -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/IO/Stream.php

Doc Comments +5 added lines, -2 removed lines

@@ -139,8 +139,7 @@ 
      *
      * @param string|resource $stream Either a valid stream URI or an open
      *     stream resource (using fopen, fsockopen, et al.)
-     * @param array $options An array of any/none of the following options
-     *                          (see $options var above for more details)
+     * @param string $mode
      */
     public function __construct($stream, $mode = null, $context = null)
     {
@@ -194,6 +193,9 @@ 
         return false;
     }
 
+    /**
+     * @param resource $stream
+     */
     protected function setMetaData($stream)
     {
         $this->meta = stream_get_meta_data($stream);
@@ -360,6 +362,7 @@ 
      * Writes a string to the stream (if it is writable)
      *
      * @param string The data to be written to the stream
+     * @param string $str
      * @return int The number of bytes written to the stream
      * @throws CSVelte\Exception\IOException
      */

Unused Use Statements -2 removed lines

@@ -14,14 +14,12 @@
 namespace CSVelte\IO;
 
 use CSVelte\Traits\ReadLine;
-
 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 +2 added lines

@@ -300,6 +300,7 @@ 
      * Remove quotes wrapping text.
      *
      * @param string The data to unquote
+     * @param string|null $data
      * @return string The data with quotes stripped from the outside of it
      * @internal
      */
@@ -326,6 +327,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 +8 added lines, -4 removed lines

@@ -127,7 +127,7 @@ 
     /**
      * I'm not sure what this is for...
      * @param  Readable $input The input source
-     * @return CSVelte\Taster
+     * @return Taster
      * @todo Get rid of this unless there is a good reason for having it...?
      * @ignore
      */
@@ -143,7 +143,7 @@ 
      * such as the delimiting character, quote character, or what types of data are quoted.
      * are quoted.
      *
-     * @return CSVelte\Flavor The metadata that the CSV format doesn't provide
+     * @return Flavor The metadata that the CSV format doesn't provide
      * @access public
      * @todo Implement a lickQuote method for when lickQuoteAndDelim method fails
      * @todo Should there bea lickEscapeChar method? the python module that inspired
@@ -177,6 +177,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
@@ -191,7 +192,7 @@ 
      * Examine the input source to determine which character(s) are being used
      * as the end-of-line character
      *
-     * @return char The end-of-line char for the input data
+     * @return string The end-of-line char for the input data
      * @access protected
      * @credit pulled from stackoverflow thread *tips hat to username "Harm"*
      * @todo This should throw an exception if it cannot determine the line ending
@@ -336,6 +337,7 @@ 
      * @param char The type of quote character being used (single or double)
      * @param char The character used as the column delimiter
      * @param char 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
@@ -422,7 +424,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)
@@ -472,6 +474,7 @@ 
      *
      * @param string The string to do the replacements on
      * @param char 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
@@ -498,6 +501,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