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

Spacing +9 added lines, -9 removed lines

@@ -194,7 +194,7 @@ 
     public function toArray()
     {
         $data = [];
-        foreach($this->data as $key => $val) {
+        foreach ($this->data as $key => $val) {
             $data[$key] = (is_object($val) && method_exists($val, 'toArray')) ? $val->toArray() : $val;
         }
         return $data;
@@ -369,7 +369,7 @@ 
             if ($i === $pos) return $key;
             $i++;
         }
-        throw new OutOfBoundsException("Collection data does not contain a key at given position: " . $pos);
+        throw new OutOfBoundsException("Collection data does not contain a key at given position: ".$pos);
     }
 
     /**
@@ -554,7 +554,7 @@ 
             return $this->data[$key];
         } else {
             if ($throwExc) {
-                throw new OutOfBoundsException("Collection data does not contain value for given key: " . $key);
+                throw new OutOfBoundsException("Collection data does not contain value for given key: ".$key);
             }
         }
         return $default;
@@ -899,7 +899,7 @@ 
     public function pairs($alt = false)
     {
         return new self(array_map(
-            function ($key, $val) use ($alt) {
+            function($key, $val) use ($alt) {
                 if ($alt) {
                     return [$key => $val];
                 } else {
@@ -981,7 +981,7 @@ 
         if (false !== ($condRet = $this->if2DMapInternalMethod(__METHOD__))) {
             return $condRet;
         }
-        $strvals = $this->map(function($val){
+        $strvals = $this->map(function($val) {
             return (string) $val;
         });
         $this->assertNumericValues();
@@ -1095,7 +1095,7 @@ 
         $this->assertIsTabular();
         return $this->sort(function($a, $b) use ($key, $cmp) {
             if (!isset($a[$key]) || !isset($b[$key])) {
-                throw new RuntimeException('Cannot order collection by non-existant key: ' . $key);
+                throw new RuntimeException('Cannot order collection by non-existant key: '.$key);
             }
             if (is_null($cmp)) {
                 return strcasecmp($a[$key], $b[$key]);
@@ -1142,7 +1142,7 @@ 
      */
     public function is2D()
     {
-        return !$this->contains(function($val){
+        return !$this->contains(function($val) {
             return !is_array($val);
         });
         return false;
@@ -1212,7 +1212,7 @@ 
 
     protected function assertNumericValues()
     {
-        if ($this->contains(function($val){
+        if ($this->contains(function($val) {
             return !is_numeric($val);
         })) {
             // can't average non-numeric data
@@ -1228,6 +1228,6 @@ 
         if (is_null($data) || is_array($data) || $data instanceof Iterator) {
             return;
         }
-        throw new InvalidArgumentException("Invalid type for collection data: " . gettype($data));
+        throw new InvalidArgumentException("Invalid type for collection data: ".gettype($data));
     }
 }

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

Spacing +3 added lines, -3 removed lines

@@ -239,7 +239,7 @@ 
     {
         if (!$this->isConnected()) {
             $e = null;
-            $errhandler = function ($errno, $errstr, $errfile, $errline) use (&$e) {
+            $errhandler = function($errno, $errstr, $errfile, $errline) use (&$e) {
                 $e = new IOException(sprintf(
                     "Could not open connection for %s using mode %s.",
                     $this->getUri(),
@@ -555,7 +555,7 @@ 
             $this->updateContext();
             return $this;
         }
-        throw new InvalidArgumentException("Context options must be an array, got: " . gettype($options));
+        throw new InvalidArgumentException("Context options must be an array, got: ".gettype($options));
     }
 
     /**
@@ -575,7 +575,7 @@ 
             $this->updateContext();
             return $this;
         }
-        throw new InvalidArgumentException("Context parameters must be an array, got: " . gettype($params));
+        throw new InvalidArgumentException("Context parameters must be an array, got: ".gettype($params));
     }
 
     /**

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

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

Spacing +1 added lines, -1 removed lines

@@ -68,7 +68,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 = collect(array_values($fields));

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)

Spacing +16 added lines, -16 removed lines

@@ -215,16 +215,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;
             }
@@ -256,12 +256,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...
@@ -530,7 +530,7 @@ 
             if ($types->contains(self::DATA_NONNUMERIC)) {
                 // allow for a SMALL amount of error here
                 $counts = collect([self::DATA_SPECIAL => 0, self::DATA_NONNUMERIC => 0]);
-                $freq->get('quoted')->walk(function ($type) use (&$counts) {
+                $freq->get('quoted')->walk(function($type) use (&$counts) {
                     $counts->increment($type);
                 });
                 // @todo is all this even necessary? seems unnecessary to me...
@@ -651,13 +651,13 @@ 
                 $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 = new DateTime($data);
-                $dt->setTime(0,0,0);
+                $dt->setTime(0, 0, 0);
                 $now = new DateTime();
-                $now->setTime(0,0,0);
+                $now->setTime(0, 0, 0);
                 $diff = $dt->diff($now);
-                $diffDays = (integer) $diff->format( "%R%a" );
+                $diffDays = (integer) $diff->format("%R%a");
                 if ($diffDays === 0) {
                     // then this is most likely a time string...
                     if (preg_match("/^{$time}$/i", $data)) {
@@ -666,7 +666,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/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();

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