nozavroni / csvelte

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();

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
@@ -414,7 +415,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)
@@ -464,6 +465,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
      * @access protected
      * @todo I could probably pass in (maybe optionally) the newline character I
@@ -490,6 +493,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
@@ -546,6 +550,7 @@ 
      * @param string $delim The CSV data's delimiting char (can be a variety of chars but)
      *     typically $eol 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

Indentation +14 added lines, -14 removed lines

@@ -261,20 +261,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
-      * @access protected
-      * @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 Use replaceQuotedSpecialChars rather than removeQuotedStrings
-      */
+        /**
+         * 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
+         * @access protected
+         * @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 Use replaceQuotedSpecialChars rather than removeQuotedStrings
+         */
     protected function lickDelimiter($eol = "\n")
     {
         $delimiters = array(",", "\t", "|", ":", ";", "/", '\\');

src/CSVelte/Reader.php

Doc Comments +7 added lines, -3 removed lines

@@ -127,7 +127,7 @@ 
      * accept any string (or any object with a __toString() method), or an
      * SplFileObject, so long as it represents a file rather than a directory. 
      *
-     * @param \CSVelte\Contract\Readable|object|string|SplFileObject $input See description
+     * @param Readable $input See description
      * @return $this
      */
     protected function setSource($input)
@@ -328,6 +328,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)
     {
@@ -338,6 +341,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
@@ -417,7 +421,7 @@ 
     /**
      * Retrieve header row.
      *
-     * @return CSVelte\Table\HeaderRow|null The header row if there is one
+     * @return HeaderRow The header row if there is one
      */
     public function header()
     {
@@ -458,7 +462,7 @@ 
     /**
      * Returns an iterator with rows from user-supplied filter functions removed
      *
-     * @return CSVelte\Reader\FilteredReader An iterator with filtered rows
+     * @return FilteredReader An iterator with filtered rows
      */
     public function filter()
     {

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/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)

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
  *