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

Spacing +5 added lines, -5 removed lines

@@ -141,7 +141,7 @@ 
     {
         if (is_array($rows)) $rows = new ArrayIterator($rows);
         if (!($rows instanceof Iterator)) {
-            throw new InvalidArgumentException('First argument for ' . __METHOD__ . ' must be iterable');
+            throw new InvalidArgumentException('First argument for '.__METHOD__.' must be iterable');
         }
         $written = 0;
         if ($rows instanceof Reader) {
@@ -165,7 +165,7 @@ 
     {
         $items = array();
         foreach ($row as $data) {
-            $items []= $this->prepareData($data);
+            $items [] = $this->prepareData($data);
         }
         $row = new Row($items);
         return $row;
@@ -193,11 +193,11 @@ 
         // to use it for very long, in fact, once I finish writing the Data class
         // it is gonezo!
         $hasSpecialChars = function($s) use ($flvr) {
-            $specialChars = preg_quote($flvr->lineTerminator . $flvr->quoteChar . $flvr->delimiter);
+            $specialChars = preg_quote($flvr->lineTerminator.$flvr->quoteChar.$flvr->delimiter);
             $pattern = "/[{$specialChars}]/m";
             return preg_match($pattern, $s);
         };
-        switch($flvr->quoteStyle) {
+        switch ($flvr->quoteStyle) {
             case Flavor::QUOTE_ALL:
                 $doQuote = true;
                 break;
@@ -227,6 +227,6 @@ 
         $escapeQuote = "";
         if ($isQuoted) $escapeQuote = ($flvr->doubleQuote) ? $flvr->quoteChar : $flvr->escapeChar;
         // @todo Not sure what else, if anything, I'm supposed to be escaping here..
-        return str_replace($flvr->quoteChar, $escapeQuote . $flvr->quoteChar, $str);
+        return str_replace($flvr->quoteChar, $escapeQuote.$flvr->quoteChar, $str);
     }
 }

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

Spacing +13 added lines, -13 removed lines

@@ -193,16 +193,16 @@ 
     {
         $str = $this->removeQuotedStrings($this->sample);
         $eols = [
-            self::EOL_WINDOWS => "\r\n",  // 0x0D - 0x0A - Windows, DOS OS/2
-            self::EOL_UNIX    => "\n",    // 0x0A -      - Unix, OSX
-            self::EOL_TRS80   => "\r",    // 0x0D -      - Apple ][, TRS80
+            self::EOL_WINDOWS => "\r\n", // 0x0D - 0x0A - Windows, DOS OS/2
+            self::EOL_UNIX    => "\n", // 0x0A -      - Unix, OSX
+            self::EOL_TRS80   => "\r", // 0x0D -      - Apple ][, TRS80
         ];
 
         $curCount = 0;
         // @todo This should return a default maybe?
         $curEol = PHP_EOL;
-        foreach($eols as $k => $eol) {
-            if( ($count = substr_count($str, $eol)) > $curCount) {
+        foreach ($eols as $k => $eol) {
+            if (($count = substr_count($str, $eol)) > $curCount) {
                 $curCount = $count;
                 $curEol = $eol;
             }
@@ -235,12 +235,12 @@ 
         $patterns = [];
         // delim can be anything but line breaks, quotes, alphanumeric, underscore, backslash, or any type of spaces
         $antidelims = implode(array("\r", "\n", "\w", preg_quote('"', '/'), preg_quote("'", '/')/*, preg_quote('\\', '/')*/, preg_quote(chr(self::SPACE), '/')));
-        $delim = '(?P<delim>[^' . $antidelims . '])';
+        $delim = '(?P<delim>[^'.$antidelims.'])';
         $quote = '(?P<quoteChar>"|\'|`)'; // @todo I think MS Excel uses some strange encoding for fancy open/close quotes
-        $patterns[] = '/' . $delim . ' ?' . $quote . '.*?\2\1/ms'; // ,"something", - anything but whitespace or quotes followed by a possible space followed by a quote followed by anything followed by same quote, followed by same anything but whitespace
-        $patterns[] = '/(?:^|\n)' . $quote . '.*?\1' . $delim . ' ?/ms'; // 'something', - beginning of line or line break, followed by quote followed by anything followed by quote followed by anything but whitespace or quotes
-        $patterns[] = '/' . $delim . ' ?' . $quote . '.*?\2(?:^|\n)/ms'; // ,'something' - anything but whitespace or quote followed by possible space followed by quote followed by anything followed by quote, followed by end of line
-        $patterns[] = '/(?:^|\n)' . $quote . '.*?\2(?:$|\n)/ms'; // 'something' - beginning of line followed by quote followed by anything followed by quote followed by same quote followed by end of line
+        $patterns[] = '/'.$delim.' ?'.$quote.'.*?\2\1/ms'; // ,"something", - anything but whitespace or quotes followed by a possible space followed by a quote followed by anything followed by same quote, followed by same anything but whitespace
+        $patterns[] = '/(?:^|\n)'.$quote.'.*?\1'.$delim.' ?/ms'; // 'something', - beginning of line or line break, followed by quote followed by anything followed by quote followed by anything but whitespace or quotes
+        $patterns[] = '/'.$delim.' ?'.$quote.'.*?\2(?:^|\n)/ms'; // ,'something' - anything but whitespace or quote followed by possible space followed by quote followed by anything followed by quote, followed by end of line
+        $patterns[] = '/(?:^|\n)'.$quote.'.*?\2(?:$|\n)/ms'; // 'something' - beginning of line followed by quote followed by anything followed by quote followed by same quote followed by end of line
         foreach ($patterns as $pattern) {
             // @todo I had to add the error suppression char here because it was
             //     causing undefined offset errors with certain data sets. strange...
@@ -385,7 +385,7 @@ 
             if (array_key_exists(self::DATA_NONNUMERIC, array_flip($types))) {
                 // allow for a SMALL amount of error here
                 $counts = array(self::DATA_SPECIAL => 0, self::DATA_NONNUMERIC => 0);
-                array_walk($freq['quoted'], function ($val) use (&$counts) {
+                array_walk($freq['quoted'], function($val) use (&$counts) {
                     $counts[$val]++;
                 });
                 arsort($counts);
@@ -511,7 +511,7 @@ 
                 $day = '[0-3]?[0-9]';
                 $sep = '[\/\.\-]?';
                 $time = '([0-2]?[0-9](:[0-5][0-9]){1,2}(am|pm)?|[01]?[0-9](am|pm))';
-                $date = '(' . $month . $sep . $day . $sep . $year . '|' . $day . $sep . $month . $sep . $year . '|' . $year . $sep . $month . $sep . $day . ')';
+                $date = '('.$month.$sep.$day.$sep.$year.'|'.$day.$sep.$month.$sep.$year.'|'.$year.$sep.$month.$sep.$day.')';
                 $dt = Carbon::parse($data);
                 if ($dt->today()) {
                     // then this is most likely a time string...
@@ -521,7 +521,7 @@ 
                 }
                 if (preg_match("/^{$date}$/i", $data)) {
                     return self::TYPE_DATE;
-                } elseif(preg_match("/^{$date} {$time}$/i")) {
+                } elseif (preg_match("/^{$date} {$time}$/i")) {
                     return self::TYPE_DATETIME;
                 }
             } catch (\Exception $e) {

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

Spacing +4 added lines, -4 removed lines

@@ -185,7 +185,7 @@ 
             do {
                 if (!isset($lines)) $lines = array();
                 if (false === ($line = $this->source->readLine($eol))) {
-                    throw new EndOfFileException("End of file reached: " . $this->source->getName());
+                    throw new EndOfFileException("End of file reached: ".$this->source->getName());
                 }
                 array_push($lines, rtrim($line, $eol));
             } while ($this->inQuotedString(end($lines), $f->quoteChar, $f->escapeChar));
@@ -279,7 +279,7 @@ 
      */
     protected function replaceQuotedSpecialChars($data, $delim, $quo, $eol)
     {
-        return preg_replace_callback('/(['. preg_quote($quo, '/') . '])(.*)\1/imsU', function($matches) use ($delim, $eol) {
+        return preg_replace_callback('/(['.preg_quote($quo, '/').'])(.*)\1/imsU', function($matches) use ($delim, $eol) {
             $ret = str_replace($eol, self::PLACEHOLDER_NEWLINE, $matches[0]);
             $ret = str_replace($delim, self::PLACEHOLDER_DELIM, $ret);
             return $ret;
@@ -331,7 +331,7 @@ 
      */
     protected function unEscape($str, $esc, $quo)
     {
-        return str_replace($esc . $quo, $quo, $str);
+        return str_replace($esc.$quo, $quo, $str);
     }
 
     /**
@@ -472,7 +472,7 @@ 
      */
     public function toArray()
     {
-        return array_map(function($row){
+        return array_map(function($row) {
             return $row->toArray();
         }, iterator_to_array($this));
     }

src/CSVelte/Reader/FilteredIterator.php

Spacing +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
 
     public function toArray()
     {
-        return array_map(function($row){
+        return array_map(function($row) {
             return $row->toArray();
         }, iterator_to_array($this));
     }

src/CSVelte/Flavor.php

Spacing +2 added lines, -2 removed lines

@@ -192,7 +192,7 @@ 
     protected function assertValidAttribute($attr)
     {
         if (!property_exists(self::class, $attr))
-            throw new InvalidArgumentException("Unknown attribute: " . $attr);
+            throw new InvalidArgumentException("Unknown attribute: ".$attr);
     }
 
     /**
@@ -241,7 +241,7 @@ 
      */
     public function __set($attr, $val)
     {
-        throw new ImmutableException("Cannot change attributes on an immutable object: " . self::class . "::\$" . $attr);
+        throw new ImmutableException("Cannot change attributes on an immutable object: ".self::class."::\$".$attr);
     }
 
     public function toArray()

src/CSVelte/Table/AbstractRow.php

Spacing +2 added lines, -2 removed lines

@@ -67,7 +67,7 @@ 
             } elseif ($fields instanceof Iterator) {
                 $fields = iterator_to_array($fields);
             } else {
-                throw new InvalidArgumentException(__CLASS__ . " requires an array, got: " . gettype($fields));
+                throw new InvalidArgumentException(__CLASS__." requires an array, got: ".gettype($fields));
             }
         }
         $this->fields = array_values($fields);
@@ -249,7 +249,7 @@ 
     protected function assertOffsetExists($offset)
     {
         if (!$this->offsetExists($offset)) {
-            throw new OutOfBoundsException("Undefined offset: " . $offset);
+            throw new OutOfBoundsException("Undefined offset: ".$offset);
         }
     }
 

src/CSVelte/Traits/IsWritable.php

Spacing +2 added lines, -2 removed lines

@@ -40,7 +40,7 @@ 
      */
     public function writeLine($line, $eol = PHP_EOL)
     {
-        return $this->write($line . $eol);
+        return $this->write($line.$eol);
     }
 
     /**
@@ -52,7 +52,7 @@ 
     protected function assertIsWritable()
     {
         if (!$this->isWritable()) {
-            throw new IOException("Stream not writable: " . $this->getName(), IOException::ERR_NOT_WRITABLE);
+            throw new IOException("Stream not writable: ".$this->getName(), IOException::ERR_NOT_WRITABLE);
         }
     }
 

src/CSVelte/Traits/IsReadable.php

Spacing +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
     protected function assertIsReadable()
     {
         if (!$this->isReadable()) {
-            throw new IOException("Stream not readable: " . $this->getName(), IOException::ERR_NOT_READABLE);
+            throw new IOException("Stream not readable: ".$this->getName(), IOException::ERR_NOT_READABLE);
         }
     }
 

src/CSVelte/Traits/IsSeekable.php

Spacing +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
     protected function assertIsSeekable()
     {
         if (!$this->isSeekable()) {
-            throw new IOException("Stream not seekable: " . $this->getName(), IOException::ERR_NOT_SEEKABLE);
+            throw new IOException("Stream not seekable: ".$this->getName(), IOException::ERR_NOT_SEEKABLE);
         }
     }