nozavroni / csvelte

src/CSVelte/Collection.php

Doc Comments +13 added lines, -11 removed lines

@@ -614,7 +614,7 @@ 
      *
      * @param int|mixed The offset to set
      * @param any The value to set it to
-     * @return boolean
+     * @return Collection
      */
     public function offsetSet($offset, $value)
     {
@@ -770,7 +770,7 @@ 
      * Filter out unwanted items using a callback function.
      *
      * @param Callable $callback
-     * @return CSVelte\Collection A new collection with filtered items removed
+     * @return Collection A new collection with filtered items removed
      */
     public function filter(Callable $callback)
     {
@@ -822,7 +822,7 @@ 
      * Returns an array where the key is a value in the collection and the value
      * is the number of times that value appears in the collection.
      *
-     * @return CSVelte\Collection A collection of value frequencies (see description)
+     * @return Collection A collection of value frequencies (see description)
      */
     public function frequency()
     {
@@ -846,7 +846,7 @@ 
      * Returns a collection with duplicate values removed. If two-dimensional,
      * then each array within the collection will have its duplicates removed.
      *
-     * @return CSVelte\Collection A new collection with duplicate values removed.
+     * @return Collection A new collection with duplicate values removed.
      */
     public function unique()
     {
@@ -862,7 +862,7 @@ 
      * Returns a collection of arrays where the key is the duplicate value
      * and the value is an array of keys from the original collection.
      *
-     * @return CSVelte\Collection A new collection with duplicate values.
+     * @return Collection A new collection with duplicate values.
      */
     public function duplicates()
     {
@@ -880,7 +880,7 @@ 
      *
      * Get a new collection where the keys and values have been swapped.
      *
-     * @return CSVelte\Collection A new collection where keys/values have been swapped
+     * @return Collection A new collection where keys/values have been swapped
      */
     public function flip()
     {
@@ -894,7 +894,7 @@ 
      * first is the default.
      *
      * @param boolean Whether you want pairs in [k => v] rather than [k, v] format
-     * @return CSVelte\Collection A collection of key/value pairs
+     * @return Collection A collection of key/value pairs
      */
     public function pairs($alt = false)
     {
@@ -1056,9 +1056,8 @@ 
      * default it uses a case-insensitive natural order algorithm, but you can
      * pass it any sorting algorithm you like.
      *
-     * @param Callable $sort_func The sorting function you want to use
      * @param boolean $preserve_keys Whether you want to preserve keys
-     * @return CSVelte\Collection A new collection sorted by $callback
+     * @return Collection A new collection sorted by $callback
      */
     public function sort(Callable $callback = null, $preserve_keys = true)
     {
@@ -1088,7 +1087,7 @@ 
      * @param string $key The key you want to order by
      * @param Callable $cmp The sorting comparison algorithm to use
      * @param boolean $preserve_keys Whether keys should be preserved
-     * @return CSVelte\Collection A new collection sorted by $cmp and $key
+     * @return Collection A new collection sorted by $cmp and $key
      */
     public function orderBy($key, Callable $cmp = null, $preserve_keys = true)
     {
@@ -1112,13 +1111,16 @@ 
      * trying to write a particular sorting algurithm that sorts forwards and back.
      *
      * @param boolean $preserve_keys Whether keys should be preserved
-     * @return CSVelte\Collection A new collection in reverse order
+     * @return Collection A new collection in reverse order
      */
     public function reverse($preserve_keys = true)
     {
         return new self(array_reverse($this->data, $preserve_keys));
     }
 
+    /**
+     * @param string $method
+     */
     protected function if2DMapInternalMethod($method)
     {
         if ($this->is2D()) {

Braces +30 added lines, -11 removed lines

@@ -153,8 +153,9 @@ 
             }
         } else {
             if (is_null($key)) {
-                if (is_array($val)) return $this->merge($val);
-                else {
+                if (is_array($val)) {
+                    return $this->merge($val);
+                } else {
                     if (is_callable($val)) {
                         return $this->map($val);
                     } /*else {
@@ -248,7 +249,9 @@ 
     {
         if (is_callable($callback = $val)) {
             foreach ($this->data as $key => $val) {
-                if ($callback($val, $key)) return true;
+                if ($callback($val, $key)) {
+                    return true;
+                }
             }
         } elseif (in_array($val, $this->data)) {
             return (is_null($key) || (isset($this->data[$key]) && $this->data[$key] == $val));
@@ -366,7 +369,9 @@ 
     {
         $i = 0;
         foreach ($this->data as $key => $val) {
-            if ($i === $pos) return $key;
+            if ($i === $pos) {
+                return $key;
+            }
             $i++;
         }
         throw new OutOfBoundsException("Collection data does not contain a key at given position: " . $pos);
@@ -744,7 +749,9 @@ 
     {
         foreach ($this->data as $key => $val) {
             if (!$ret = $callback($val, $key)) {
-                if ($ret === false) break;
+                if ($ret === false) {
+                    break;
+                }
             }
         }
         return $this;
@@ -776,7 +783,9 @@ 
     {
         $keys = [];
         foreach ($this->data as $key => $val) {
-            if (false === $callback($val, $key)) $keys[$key] = true;
+            if (false === $callback($val, $key)) {
+                $keys[$key] = true;
+            }
         }
         return new self(array_diff_key($this->data, $keys));
     }
@@ -793,7 +802,9 @@ 
     public function first(Callable $callback)
     {
         foreach ($this->data as $key => $val) {
-            if ($callback($val, $key)) return $val;
+            if ($callback($val, $key)) {
+                return $val;
+            }
         }
         return null;
     }
@@ -811,7 +822,9 @@ 
     {
         $elem = null;
         foreach ($this->data as $key => $val) {
-            if ($callback($val, $key)) $elem = $val;
+            if ($callback($val, $key)) {
+                $elem = $val;
+            }
         }
         return $elem;
     }
@@ -1062,7 +1075,9 @@ 
      */
     public function sort(Callable $callback = null, $preserve_keys = true)
     {
-        if (is_null($callback)) $callback = 'strcasecmp';
+        if (is_null($callback)) {
+            $callback = 'strcasecmp';
+        }
         if (!is_callable($callback)) {
             throw new InvalidArgumentException(sprintf(
                 'Invalid argument supplied for %s. Expected %s, got: "%s".',
@@ -1172,7 +1187,9 @@ 
 
             // if the list of array keys is shorter than the total amount of items in
             // the collection, than this is not tabular data
-            if (count($test) != count($this)) return false;
+            if (count($test) != count($this)) {
+                return false;
+            }
 
             // loop through the array of each item's array keys that we just created
             // and compare it to the FIRST item. If any array contains different keys
@@ -1180,7 +1197,9 @@ 
             $first = array_shift($test);
             foreach ($test as $key => $keys) {
                 $diff = array_diff($first, $keys);
-                if (!empty($diff)) return false;
+                if (!empty($diff)) {
+                    return false;
+                }
             }
             return true;
         }

src/CSVelte/IO/BufferStream.php

Doc Comments +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
     /**
      * Return the current position within the stream/readable
      *
-     * @return int The current position within readable
+     * @return boolean The current position within readable
      */
     public function tell()
     {

src/CSVelte/IO/IteratorStream.php

Doc Comments +3 added lines, -3 removed lines

@@ -176,7 +176,7 @@ 
     /**
      * Return the current position within the stream/readable
      *
-     * @return int The current position within readable
+     * @return boolean The current position within readable
      */
     public function tell()
     {
@@ -228,7 +228,7 @@ 
     /**
      * Closes the stream and any underlying resources.
      *
-     * @return void
+     * @return boolean
      */
     public function close()
     {
@@ -278,7 +278,7 @@ 
      * Write data to the output.
      *
      * @param string The data to write
-     * @return int The number of bytes written
+     * @return boolean The number of bytes written
      */
     public function write($data)
     {

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

Braces +9 added lines, -3 removed lines

@@ -254,7 +254,9 @@ 
                 $this->getContext()
             );
             restore_error_handler();
-            if ($e) throw $e;
+            if ($e) {
+                throw $e;
+            }
         }
         return $this->isConnected();
     }
@@ -328,7 +330,9 @@ 
     public function setMode($mode = null)
     {
         $this->assertNotConnected(__METHOD__);
-        if (is_null($mode)) $mode = "r+b";
+        if (is_null($mode)) {
+            $mode = "r+b";
+        }
 
         $mode = substr($mode, 0, 3);
         $rest = substr($mode, 1);
@@ -436,7 +440,9 @@ 
      */
     protected function setLazy($lazy)
     {
-        if (is_null($lazy)) $lazy = true;
+        if (is_null($lazy)) {
+            $lazy = true;
+        }
         $this->lazy = (boolean) $lazy;
         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()
     {

Braces +9 added lines, -3 removed lines

@@ -136,7 +136,9 @@ 
     {
         $resource = (new Resource($uri, $mode))
             ->setContextResource($context);
-        if (!$lazy) $resource->connect();
+        if (!$lazy) {
+            $resource->connect();
+        }
         return new self($resource);
     }
 
@@ -169,7 +171,9 @@ 
             }
             // if a certain value was requested, return it
             // otherwise, return entire array
-            if (is_null($key)) return $this->meta;
+            if (is_null($key)) {
+                return $this->meta;
+            }
             return (array_key_exists($key, $this->meta)) ? $this->meta[$key] : null;
         }
     }
@@ -315,7 +319,9 @@ 
     public function read($length)
     {
         $this->assertIsReadable();
-        if ($this->eof()) return false;
+        if ($this->eof()) {
+            return false;
+        }
         return fread($this->resource->getHandle(), $length);
     }
 

src/CSVelte/Table/AbstractRow.php

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 void
+     * @return string|null
      * @access public
      */
     public function rewind()

Braces +6 added lines, -2 removed lines

@@ -151,7 +151,9 @@ 
     public function next()
     {
         $this->position++;
-        if ($this->valid()) return $this->current();
+        if ($this->valid()) {
+            return $this->current();
+        }
     }
 
     /**
@@ -163,7 +165,9 @@ 
     public function rewind()
     {
         $this->position = 0;
-        if ($this->valid()) return $this->current();
+        if ($this->valid()) {
+            return $this->current();
+        }
     }
 
     /**

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)

Braces +34 added lines, -12 removed lines

@@ -169,7 +169,9 @@ 
         try {
             list($quoteChar, $delimiter) = $this->lickQuoteAndDelim();
         } catch (TasterException $e) {
-            if ($e->getCode() !== TasterException::ERR_QUOTE_AND_DELIM) throw $e;
+            if ($e->getCode() !== TasterException::ERR_QUOTE_AND_DELIM) {
+                throw $e;
+            }
             $quoteChar = '"';
             $delimiter = $this->lickDelimiter($lineTerminator);
         }
@@ -265,7 +267,9 @@ 
         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...
-            if (@preg_match_all($pattern, $this->sample, $matches) && $matches) break;
+            if (@preg_match_all($pattern, $this->sample, $matches) && $matches) {
+                break;
+            }
         }
         if ($matches) {
             try {
@@ -388,7 +392,9 @@ 
                  // 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;
+                    if ($delim = array_search($val, $decision)) {
+                        return $delim;
+                    }
                  }
              }
         }
@@ -431,7 +437,9 @@ 
             return $delims[collect($delims)->map(function($delim) use (&$distrib, $lines) {
                 $linedist = collect();
                 $lines->walk(function($line, $line_no) use (&$linedist, $delim) {
-                    if (!strlen($line)) return;
+                    if (!strlen($line)) {
+                        return;
+                    }
                     $sectstot = 10;
                     $sectlen = (int) (strlen($line) / $sectstot);
                     $sections = collect(str_split($line, $sectlen))
@@ -519,8 +527,12 @@ 
         $quoting_styles = $quoting_styles->filter(function($val) { return (bool) $val; });
         // if quoting_styles still has QUOTE_ALL or QUOTE_NONE, then return
         // whichever of them it is, we don't need to do anything else
-        if ($quoting_styles->has(Flavor::QUOTE_ALL)) return Flavor::QUOTE_ALL;
-        if ($quoting_styles->has(Flavor::QUOTE_NONE)) return Flavor::QUOTE_NONE;
+        if ($quoting_styles->has(Flavor::QUOTE_ALL)) {
+            return Flavor::QUOTE_ALL;
+        }
+        if ($quoting_styles->has(Flavor::QUOTE_NONE)) {
+            return Flavor::QUOTE_NONE;
+        }
         if (count($types) == 1) {
             $style = $types->getValueAtPosition(0);
             if ($quoting_styles->has($style)) {
@@ -537,7 +549,9 @@ 
                 if ($most = $counts->max()) {
                     $least = $counts->min();
                     $err_margin = $least / $most;
-                    if ($err_margin < 1) return Flavor::QUOTE_NONNUMERIC;
+                    if ($err_margin < 1) {
+                        return Flavor::QUOTE_NONNUMERIC;
+                    }
                 }
             }
         }
@@ -712,7 +726,9 @@ 
                 $field = str_replace(self::PLACEHOLDER_DELIM, $delim, $field);
                 // @todo Need a Collection::setTableField($x, $y) method
                 //       See notes in green binder about refactoring Collection
-                if (!$types->has($line_no)) $types->set($line_no, collect());
+                if (!$types->has($line_no)) {
+                    $types->set($line_no, collect());
+                }
                 $types->get($line_no)->set($colpos, [
                     'type' => $this->lickType($this->unQuote($field)),
                     'length' => strlen($field)
@@ -735,12 +751,18 @@ 
                     extract($possibleHeader->get($col_no, null, true), EXTR_PREFIX_ALL, "header");
                     if ($header_type == self::TYPE_STRING) {
                         // use length
-                        if ($length != $header_length) $hasHeader++;
-                        else $hasHeader--;
+                        if ($length != $header_length) {
+                            $hasHeader++;
+                        } else {
+                            $hasHeader--;
+                        }
                     } else {
                         // use data type
-                        if ($type != $header_type) $hasHeader++;
-                        else $hasHeader--;
+                        if ($type != $header_type) {
+                            $hasHeader++;
+                        } else {
+                            $hasHeader--;
+                        }
                     }
                 } catch (OutOfBoundsException $e) {
                     // failure...

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

Braces +18 added lines, -6 removed lines

@@ -64,7 +64,9 @@ 
      */
     public function __construct(Writable $output, $flavor = null)
     {
-        if (!($flavor instanceof Flavor)) $flavor = new Flavor($flavor);
+        if (!($flavor instanceof Flavor)) {
+            $flavor = new Flavor($flavor);
+        }
         $this->flavor = $flavor;
         $this->output = $output;
     }
@@ -96,7 +98,9 @@ 
         if ($this->written) {
             throw new WriterException("Cannot set header row once data has already been written. ");
         }
-        if (is_array($headers)) $headers = new ArrayIterator($headers);
+        if (is_array($headers)) {
+            $headers = new ArrayIterator($headers);
+        }
         $this->headers = $headers;
     }
 
@@ -114,7 +118,9 @@ 
             $headerRow = new HeaderRow((array) $this->headers);
             $this->writeHeaderRow($headerRow);
         }
-        if (is_array($row)) $row = new ArrayIterator($row);
+        if (is_array($row)) {
+            $row = new ArrayIterator($row);
+        }
         $row = $this->prepareRow($row);
         if ($count = $this->output->writeLine($row->join($delim), $eol)) {
             $this->written++;
@@ -139,7 +145,9 @@ 
      */
     public function writeRows($rows)
     {
-        if (is_array($rows)) $rows = new ArrayIterator($rows);
+        if (is_array($rows)) {
+            $rows = new ArrayIterator($rows);
+        }
         if (!($rows instanceof Iterator)) {
             throw new InvalidArgumentException('First argument for ' . __METHOD__ . ' must be iterable');
         }
@@ -148,7 +156,9 @@ 
             $this->writeHeaderRow($rows->header());
         }
         foreach ($rows as $row) {
-            if ($this->writeRow($row)) $written++;
+            if ($this->writeRow($row)) {
+                $written++;
+            }
         }
         return $written;
     }
@@ -225,7 +235,9 @@ 
     {
         $flvr = $this->getFlavor();
         $escapeQuote = "";
-        if ($isQuoted) $escapeQuote = ($flvr->doubleQuote) ? $flvr->quoteChar : $flvr->escapeChar;
+        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);
     }

src/CSVelte/Flavor.php

Braces +3 added lines, -2 removed lines

@@ -191,8 +191,9 @@
      */
     protected function assertValidAttribute($attr)
     {
-        if (!property_exists(self::class, $attr))
-            throw new InvalidArgumentException("Unknown attribute: " . $attr);
+        if (!property_exists(self::class, $attr)) {
+                    throw new InvalidArgumentException("Unknown attribute: " . $attr);
+        }
     }
 
     /**