adding ResultSet::createFromReader

Author: nyamsprod

CHANGELOG.md

@@ -9,8 +9,9 @@ All Notable changes to `Csv` will be documented in this file
 - More return types and type parameters as supported in PHP7.2+
 - `League\Csv\Statement::create` named constructor to ease constraint builder instantiation
 - `League\Csv\Statement` can now also process `League\Csv\ResultSet` instances.
-- `League\Csv\ResultSet::getRecords` has an optional `$header` second argument to make the method works like `League\Csv\Reader::getRecords` 
 - `League\Csv\TabularDataReader` interface to represent how to read tabular data
+- `League\Csv\ResultSet::getRecords` has an optional `$header` second argument to make the method works like `League\Csv\Reader::getRecords` 
+- `League\Csv\ResultSet::createFromReader` create a new instance from `League\Csv\Reader` 
 
 ### Deprecated
 

src/Reader.php

@@ -199,29 +199,23 @@ protected function removeBOM(array $record, int $bom_length, string $enclosure):
      */
     public function fetchColumn($index = 0): Iterator
     {
-        $tabular_data = new ResultSet($this->getRecords(), $this->getHeader());
-
-        return $tabular_data->fetchColumn($index);
+        return ResultSet::createFromReader($this)->fetchColumn($index);
     }
 
     /**
      * {@inheritdoc}
      */
     public function fetchOne(int $nth_record = 0): array
     {
-        $tabular_data = new ResultSet($this->getRecords(), $this->getHeader());
-
-        return $tabular_data->fetchOne($nth_record);
+        return ResultSet::createFromReader($this)->fetchOne($nth_record);
     }
 
     /**
      * {@inheritdoc}
      */
     public function fetchPairs($offset_index = 0, $value_index = 1): Iterator
     {
-        $tabular_data = new ResultSet($this->getRecords(), $this->getHeader());
-
-        return $tabular_data->fetchPairs($offset_index, $value_index);
+        return ResultSet::createFromReader($this)->fetchPairs($offset_index, $value_index);
     }
 
     /**
@@ -253,18 +247,7 @@ public function jsonSerialize(): array
     }
 
     /**
-     * Returns the CSV records as an iterator object.
-     *
-     * Each CSV record is represented as a simple array containing strings or null values.
-     *
-     * If the CSV document has a header record then each record is combined
-     * to the header record and the header record is removed from the iterator.
-     *
-     * If the CSV document is inconsistent. Missing record fields are
-     * filled with null values while extra record fields are strip from
-     * the returned object.
-     *
-     * @param string[] $header an optional header to use instead of the CSV document header
+     * {@inheritDoc}
      */
     public function getRecords(array $header = []): Iterator
     {

src/ResultSet.php

@@ -72,6 +72,14 @@ public function __destruct()
         unset($this->records);
     }
 
+    /**
+     * Returns a new instance from a League\Csv\Reader object.
+     */
+    public static function createFromReader(Reader $reader): self
+    {
+        return new self($reader->getRecords(), $reader->getHeader());
+    }
+
     /**
      * Returns the header associated with the result set.
      *

src/TabularDataReader.php

@@ -23,14 +23,10 @@
 interface TabularDataReader extends Countable, IteratorAggregate
 {
     /**
-     * Returns the header associated with the tabular data.
-     *
-     * The header must contains unique string or is an empty array
-     * if no header was specified.
-     *
-     * @return string[]
+     * Returns the number of records contained in the tabular data structure
+     * excluding the header record.
      */
-    public function getHeader(): array;
+    public function count(): int;
 
     /**
      * Returns the tabular data records as an iterator object.
@@ -43,29 +39,34 @@ public function getHeader(): array;
      * If the CSV document is inconsistent. Missing record fields are
      * filled with null values while extra record fields are strip from
      * the returned object.
+     */
+    public function getIterator(): Iterator;
+
+    /**
+     * Returns the header associated with the tabular data.
      *
-     * @param string[] $header an optional header to use instead of the CSV document header
+     * The header must contains unique string or is an empty array
+     * if no header was specified.
+     *
+     * @return string[]
      */
-    public function getRecords(array $header = []): Iterator;
+    public function getHeader(): array;
 
     /**
      * Returns the tabular data records as an iterator object.
      *
      * Each record is represented as a simple array containing strings or null values.
      *
-     * If the CSV document has a header record then each record is combined
+     * If the tabular data has a header record then each record is combined
      * to the header record and the header record is removed from the iterator.
      *
-     * If the CSV document is inconsistent. Missing record fields are
+     * If the tabular data is inconsistent. Missing record fields are
      * filled with null values while extra record fields are strip from
      * the returned object.
+     *
+     * @param string[] $header an optional header to use instead of the CSV document header
      */
-    public function getIterator(): Iterator;
-
-    /**
-     * Returns the number of records contained in the tabular data structure.
-     */
-    public function count(): int;
+    public function getRecords(array $header = []): Iterator;
 
     /**
      * Returns the nth record from the tabular data.