nozavroni / csvelte

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

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

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

src/CSVelte/IO/BufferStream.php

Doc Comments +2 added lines, -2 removed lines

@@ -119,7 +119,7 @@ 
      * Read in the specified amount of characters from the input source
      *
      * @param integer Amount of characters to read from input source
-     * @return string|boolean The specified amount of characters read from input source
+     * @return false|string The specified amount of characters read from input source
      */
     public function read($chars)
     {
@@ -186,7 +186,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/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 null|AbstractRow
+     * @return string|null
      */
     public function rewind()
     {

src/CSVelte/Collection.php

Doc Comments +14 added lines, -11 removed lines

@@ -615,7 +615,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)
     {
@@ -684,7 +684,7 @@ 
      *
      * @param boolean $multi Whether to count just the items in the collection or
      *     to count the items in each tabular data row.
-     * @return int|\CSVelte\Collection Either an integer count or a collection of counts
+     * @return string Either an integer count or a collection of counts
      */
     public function count($multi = false)
     {
@@ -771,7 +771,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)
     {
@@ -823,7 +823,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()
     {
@@ -847,7 +847,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()
     {
@@ -863,7 +863,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()
     {
@@ -881,7 +881,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()
     {
@@ -895,7 +895,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)
     {
@@ -1059,7 +1059,7 @@ 
      *
      * @param Callable $callback 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)
     {
@@ -1089,7 +1089,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)
     {
@@ -1113,13 +1113,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()) {