RecordSet::__construct() - Code Metrics - Inspection of "Implementing 9.0 Public API" - thephpleague/csv - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#210)

by ignace nyamagana

created 2017-02-16 10:10 UTC

RecordSet::__construct() A

↳ Parent: RecordSet

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	4
cts	4
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2
crap	1

<?php
/**
* This file is part of the League.csv library
*
* @license http://opensource.org/licenses/MIT
* @link https://github.com/thephpleague/csv/
* @version 9.0.0
* @package League.csv
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);

namespace League\Csv;

use CallbackFilterIterator;
use Countable;
use DOMDocument;
use DOMElement;
use Generator;
use Iterator;
use IteratorAggregate;
use JsonSerializable;
use LimitIterator;

/**
 * A class to manage extracting and filtering a CSV
 *
 * @package League.csv
 * @since   9.0.0
 * @author  Ignace Nyamagana Butera <[email protected]>
 *
 */
class RecordSet implements JsonSerializable, IteratorAggregate, Countable
{
    use ValidatorTrait;

    /**
     * The CSV iterator result
     *
     * @var Iterator
     */
    protected $iterator;

    /**
     * The CSV header
     *
     * @var array
     */
    protected $column_names = [];

    /**
     * Charset Encoding for the CSV
     *
     * This information is used when converting the CSV to XML or JSON
     *
     * @var string
     */
    protected $conversion_input_encoding = 'UTF-8';

    /**
     * New instance
     *
     * @param Iterator $iterator     a CSV iterator
     * @param array    $column_names the CSV header
     */
    public function __construct(Iterator $iterator, array $column_names = [])
    {
        $this->iterator = $iterator;
        $this->column_names = $column_names;
    }

    /**
     * @inheritdoc
     */
    public function __destruct()
    {
        $this->iterator = null;
    }

    /**
     * Returns the field names associate with the RecordSet
     *
     * @return string[]
     */
    public function getColumnNames(): array
    {
        return $this->column_names;
    }

    /**
     * Returns a specific field names according to its offset
     *
     * If no field name is found or associated to the submitted
     * offset an empty string is returned
     *
     * @param int $offset
     *
     * @return string
     */
    public function getColumnName(int $offset): string
    {
        return $this->column_names[$offset] ?? '';
    }

    /**
     * Returns a HTML table representation of the CSV Table
     *
     * @param string $class_attr optional classname
     *
     * @return string
     */
    public function toHTML(string $class_attr = 'table-csv-data'): string
    {
        $doc = $this->toXML('table', 'tr', 'td', 'title');
        $doc->documentElement->setAttribute('class', $class_attr);

        return $doc->saveHTML($doc->documentElement);
    }

    /**
     * Transforms a CSV into a XML
     *
     * @param string $root_name        XML root node name
     * @param string $row_name         XML row node name
     * @param string $cell_name        XML cell node name
     * @param string $column_attr_name XML column attribute name
     *
     * @return DOMDocument
     */
    public function toXML(
        string $root_name = 'csv',
        string $row_name = 'row',
        string $cell_name = 'cell',
        string $column_attr_name = 'name'
    ): DOMDocument {
        $doc = new DOMDocument('1.0', 'UTF-8');
        $root = $doc->createElement($root_name);
        foreach ($this->convertToUtf8($this->iterator) as $row) {
            $root->appendChild($this->toDOMNode($doc, $row, $row_name, $cell_name, $column_attr_name));
        }
        $doc->appendChild($root);

        return $doc;
    }

    /**
     * convert a Record into a DOMNode
     *
     * @param DOMDocument $doc              The DOMDocument
     * @param array       $row              The CSV record
     * @param string      $row_name         XML row node name
     * @param string      $cell_name        XML cell node name
     * @param string      $column_attr_name XML header attribute name
     *
     * @return DOMElement
     */
    protected function toDOMNode(
        DOMDocument $doc,
        array $row,
        string $row_name,
        string $cell_name,
        string $column_attr_name
    ): DOMElement {
        $rowElement = $doc->createElement($row_name);
        foreach ($row as $name => $value) {
            $content = $doc->createTextNode($value);
            $cell = $doc->createElement($cell_name);
            if (!empty($this->column_names)) {
                $cell->setAttribute($column_attr_name, $name);
            }
            $cell->appendChild($content);
            $rowElement->appendChild($cell);
        }

        return $rowElement;
    }

    /**
     * Convert Csv file into UTF-8
     *
     * @param Iterator $iterator
     *
     * @return Iterator
     */
    protected function convertToUtf8(Iterator $iterator): Iterator
    {
        if (stripos($this->conversion_input_encoding, 'UTF-8') !== false) {
            return $iterator;
        }

        $convert_cell = function ($value) {
            return mb_convert_encoding((string) $value, 'UTF-8', $this->conversion_input_encoding);
        };

        $convert_row = function (array $row) use ($convert_cell) {
            $res = [];
            foreach ($row as $key => $value) {
                $res[$convert_cell($key)] = $convert_cell($value);
            }

            return $res;
        };

        return new MapIterator($iterator, $convert_row);
    }

    /**
     * @inheritdoc
     */
    public function getIterator(): Iterator
    {
        return $this->iterator;
    }

    /**
     * @inheritdoc
     */
    public function count(): int
    {
        return iterator_count($this->iterator);
    }

    /**
     * @inheritdoc
     */
    public function jsonSerialize()
    {
        return iterator_to_array($this->convertToUtf8($this->iterator), false);
    }

    /**
     * Returns a sequential array of all CSV lines
     *
     * @return array
     */
    public function fetchAll(): array
    {
        return iterator_to_array($this->iterator);
    }

    /**
     * Returns a single row from the CSV
     *
     * By default if no offset is provided the first row of the CSV is selected
     *
     * @param int $offset the CSV row offset
     *
     * @return array
     */
    public function fetchOne(int $offset = 0): array
    {
        $offset = $this->filterInteger($offset, 0, 'the submitted offset is invalid');
        $it = new LimitIterator($this->iterator, $offset, 1);
        $it->rewind();

        return (array) $it->current();
    }

    /**
     * Returns the next value from a single CSV column
     *
     * By default if no column index is provided the first column of the CSV is selected
     *
     * @param string|int $index CSV column index
     *
     * @return Iterator
     */
    public function fetchColumn($index = 0): Iterator
    {
        $offset = $this->getColumnIndex($index, 'the column index value is invalid');
        $filter = function (array $row) use ($offset) {
            return isset($row[$offset]);
        };

        $select = function ($row) use ($offset) {
            return $row[$offset];
        };

        return new MapIterator(new CallbackFilterIterator($this->iterator, $filter), $select);
    }

    /**
     * Filter a column name against the CSV header if any
     *
     * @param string|int $field         the field name or the field index
     * @param string     $error_message the associated error message
     *
     * @throws Exception if the field is invalid
     *
     * @return string|int
     */
    protected function getColumnIndex($field, string $error_message)
    {
        if (false !== array_search($field, $this->column_names, true) || is_string($field)) {
            return $field;
        }

        $index = $this->filterInteger($field, 0, $error_message);
        if (empty($this->column_names)) {
            return $index;
        }

        if (false !== ($index = array_search($index, array_flip($this->column_names), true))) {
            return $index;
        }

        throw new Exception($error_message);
    }

    /**
     * Fetches the next key-value pairs from a result set (first
     * column is the key, second column is the value).
     *
     * By default if no column index is provided:
     * - the first CSV column is used to provide the keys
     * - the second CSV column is used to provide the value
     *
     * @param string|int $offset_index The column index to serve as offset
     * @param string|int $value_index  The column index to serve as value
     *
     * @return Generator
     */
    public function fetchPairs($offset_index = 0, $value_index = 1): Generator
    {
        $offset = $this->getColumnIndex($offset_index, 'the offset index value is invalid');
        $value = $this->getColumnIndex($value_index, 'the value index value is invalid');

        $filter = function ($row) use ($offset) {
            return isset($row[$offset]);
        };

        $select = function ($row) use ($offset, $value) {
            return [$row[$offset], $row[$value] ?? null];
        };

        $it = new MapIterator(new CallbackFilterIterator($this->iterator, $filter), $select);

        foreach ($it as $row) {
            yield $row[0] => $row[1];
        }
    }

    /**
     * Sets the CSV encoding charset
     *
     * @param string $str
     *
     * @return static
     */
    public function setConversionInputEncoding(string $str): self
    {
        $str = str_replace('_', '-', $str);
        $str = filter_var($str, FILTER_SANITIZE_STRING, ['flags' => FILTER_FLAG_STRIP_LOW | FILTER_FLAG_STRIP_HIGH]);
        $str = trim($str);
        if ('' === $str) {
            throw new Exception('you should use a valid charset');
        }
        $this->conversion_input_encoding = strtoupper($str);

        return $this;
    }
}


1		<?php
2		/**
3		* This file is part of the League.csv library
4		*
5		* @license http://opensource.org/licenses/MIT
6		* @link https://github.com/thephpleague/csv/
7		* @version 9.0.0
8		* @package League.csv
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13		declare(strict_types=1);
14
15		namespace League\Csv;
16
17		use CallbackFilterIterator;
18		use Countable;
19		use DOMDocument;
20		use DOMElement;
21		use Generator;
22		use Iterator;
23		use IteratorAggregate;
24		use JsonSerializable;
25		use LimitIterator;
26
27		/**
28		* A class to manage extracting and filtering a CSV
29		*
30		* @package League.csv
31		* @since 9.0.0
32		* @author Ignace Nyamagana Butera <[email protected]>
33		*
34		*/
35		class RecordSet implements JsonSerializable, IteratorAggregate, Countable
36		{
37		use ValidatorTrait;
38
39		/**
40		* The CSV iterator result
41		*
42		* @var Iterator
43		*/
44		protected $iterator;
45
46		/**
47		* The CSV header
48		*
49		* @var array
50		*/
51		protected $column_names = [];
52
53		/**
54		* Charset Encoding for the CSV
55		*
56		* This information is used when converting the CSV to XML or JSON
57		*
58		* @var string
59		*/
60		protected $conversion_input_encoding = 'UTF-8';
61
62		/**
63		* New instance
64		*
65		* @param Iterator $iterator a CSV iterator
66		* @param array $column_names the CSV header
67		*/
68	106	public function __construct(Iterator $iterator, array $column_names = [])
69		{
70	106	$this->iterator = $iterator;
71	106	$this->column_names = $column_names;
72	106	}
73
74		/**
75		* @inheritdoc
76		*/
77	106	public function __destruct()
78		{
79	106	$this->iterator = null;
80	106	}
81
82		/**
83		* Returns the field names associate with the RecordSet
84		*
85		* @return string[]
86		*/
87	6	public function getColumnNames(): array
88		{
89	6	return $this->column_names;
90		}
91
92		/**
93		* Returns a specific field names according to its offset
94		*
95		* If no field name is found or associated to the submitted
96		* offset an empty string is returned
97		*
98		* @param int $offset
99		*
100		* @return string
101		*/
102	4	public function getColumnName(int $offset): string
103		{
104	4	return $this->column_names[$offset] ?? '';
105		}
106
107		/**
108		* Returns a HTML table representation of the CSV Table
109		*
110		* @param string $class_attr optional classname
111		*
112		* @return string
113		*/
114	4	public function toHTML(string $class_attr = 'table-csv-data'): string
115		{
116	4	$doc = $this->toXML('table', 'tr', 'td', 'title');
117	4	$doc->documentElement->setAttribute('class', $class_attr);
118
119	4	return $doc->saveHTML($doc->documentElement);
120		}
121
122		/**
123		* Transforms a CSV into a XML
124		*
125		* @param string $root_name XML root node name
126		* @param string $row_name XML row node name
127		* @param string $cell_name XML cell node name
128		* @param string $column_attr_name XML column attribute name
129		*
130		* @return DOMDocument
131		*/
132	6	public function toXML(
133		string $root_name = 'csv',
134		string $row_name = 'row',
135		string $cell_name = 'cell',
136		string $column_attr_name = 'name'
137		): DOMDocument {
138	6	$doc = new DOMDocument('1.0', 'UTF-8');
139	6	$root = $doc->createElement($root_name);
140	6	foreach ($this->convertToUtf8($this->iterator) as $row) {
141	6	$root->appendChild($this->toDOMNode($doc, $row, $row_name, $cell_name, $column_attr_name));
142		}
143	6	$doc->appendChild($root);
144
145	6	return $doc;
146		}
147
148		/**
149		* convert a Record into a DOMNode
150		*
151		* @param DOMDocument $doc The DOMDocument
152		* @param array $row The CSV record
153		* @param string $row_name XML row node name
154		* @param string $cell_name XML cell node name
155		* @param string $column_attr_name XML header attribute name
156		*
157		* @return DOMElement
158		*/
159	6	protected function toDOMNode(
160		DOMDocument $doc,
161		array $row,
162		string $row_name,
163		string $cell_name,
164		string $column_attr_name
165		): DOMElement {
166	6	$rowElement = $doc->createElement($row_name);
167	6	foreach ($row as $name => $value) {
168	6	$content = $doc->createTextNode($value);
169	6	$cell = $doc->createElement($cell_name);
170	6	if (!empty($this->column_names)) {
171	4	$cell->setAttribute($column_attr_name, $name);
172		}
173	6	$cell->appendChild($content);
174	6	$rowElement->appendChild($cell);
175		}
176
177	6	return $rowElement;
178		}
179
180		/**
181		* Convert Csv file into UTF-8
182		*
183		* @param Iterator $iterator
184		*
185		* @return Iterator
186		*/
187	8	protected function convertToUtf8(Iterator $iterator): Iterator
188		{
189	8	if (stripos($this->conversion_input_encoding, 'UTF-8') !== false) {
190	6	return $iterator;
191		}
192
193		$convert_cell = function ($value) {
194	2	return mb_convert_encoding((string) $value, 'UTF-8', $this->conversion_input_encoding);
195	2	};
196
197		$convert_row = function (array $row) use ($convert_cell) {
198	2	$res = [];
199	2	foreach ($row as $key => $value) {
200	2	$res[$convert_cell($key)] = $convert_cell($value);
201		}
202
203	2	return $res;
204	2	};
205
206	2	return new MapIterator($iterator, $convert_row);
207		}
208
209		/**
210		* @inheritdoc
211		*/
212	2	public function getIterator(): Iterator
213		{
214	2	return $this->iterator;
215		}
216
217		/**
218		* @inheritdoc
219		*/
220	2	public function count(): int
221		{
222	2	return iterator_count($this->iterator);
223		}
224
225		/**
226		* @inheritdoc
227		*/
228	2	public function jsonSerialize()
229		{
230	2	return iterator_to_array($this->convertToUtf8($this->iterator), false);
231		}
232
233		/**
234		* Returns a sequential array of all CSV lines
235		*
236		* @return array
237		*/
238	62	public function fetchAll(): array
239		{
240	62	return iterator_to_array($this->iterator);
241		}
242
243		/**
244		* Returns a single row from the CSV
245		*
246		* By default if no offset is provided the first row of the CSV is selected
247		*
248		* @param int $offset the CSV row offset
249		*
250		* @return array
251		*/
252	6	public function fetchOne(int $offset = 0): array
253		{
254	6	$offset = $this->filterInteger($offset, 0, 'the submitted offset is invalid');
255	4	$it = new LimitIterator($this->iterator, $offset, 1);
256	4	$it->rewind();
257
258	4	return (array) $it->current();
259		}
260
261		/**
262		* Returns the next value from a single CSV column
263		*
264		* By default if no column index is provided the first column of the CSV is selected
265		*
266		* @param string\|int $index CSV column index
267		*
268		* @return Iterator
269		*/
270	14	public function fetchColumn($index = 0): Iterator
271		{
272	14	$offset = $this->getColumnIndex($index, 'the column index value is invalid');
273		$filter = function (array $row) use ($offset) {
274	12	return isset($row[$offset]);
275	12	};
276
277		$select = function ($row) use ($offset) {
278	8	return $row[$offset];
279	12	};
280
281	12	return new MapIterator(new CallbackFilterIterator($this->iterator, $filter), $select);
282		}
283
284		/**
285		* Filter a column name against the CSV header if any
286		*
287		* @param string\|int $field the field name or the field index
288		* @param string $error_message the associated error message
289		*
290		* @throws Exception if the field is invalid
291		*
292		* @return string\|int
293		*/
294	22	protected function getColumnIndex($field, string $error_message)
295		{
296	22	if (false !== array_search($field, $this->column_names, true) \|\| is_string($field)) {
297	2	return $field;
298		}
299
300	20	$index = $this->filterInteger($field, 0, $error_message);
301	20	if (empty($this->column_names)) {
302	16	return $index;
303		}
304
305	4	if (false !== ($index = array_search($index, array_flip($this->column_names), true))) {
306	2	return $index;
307		}
308
309	2	throw new Exception($error_message);
310		}
311
312		/**
313		* Fetches the next key-value pairs from a result set (first
314		* column is the key, second column is the value).
315		*
316		* By default if no column index is provided:
317		* - the first CSV column is used to provide the keys
318		* - the second CSV column is used to provide the value
319		*
320		* @param string\|int $offset_index The column index to serve as offset
321		* @param string\|int $value_index The column index to serve as value
322		*
323		* @return Generator
324		*/
325	8	public function fetchPairs($offset_index = 0, $value_index = 1): Generator
326		{
327	8	$offset = $this->getColumnIndex($offset_index, 'the offset index value is invalid');
328	8	$value = $this->getColumnIndex($value_index, 'the value index value is invalid');
329
330		$filter = function ($row) use ($offset) {
331	8	return isset($row[$offset]);
332	8	};
333
334	8	$select = function ($row) use ($offset, $value) {
335	6	return [$row[$offset], $row[$value] ?? null];
336	8	};
337
338	8	$it = new MapIterator(new CallbackFilterIterator($this->iterator, $filter), $select);
339
340	8	foreach ($it as $row) {
341	6	yield $row[0] => $row[1];
342		}
343	8	}
344
345		/**
346		* Sets the CSV encoding charset
347		*
348		* @param string $str
349		*
350		* @return static
351		*/
352	4	public function setConversionInputEncoding(string $str): self
353		{
354	4	$str = str_replace('_', '-', $str);
355	4	$str = filter_var($str, FILTER_SANITIZE_STRING, ['flags' => FILTER_FLAG_STRIP_LOW \| FILTER_FLAG_STRIP_HIGH]);
356	4	$str = trim($str);
357	4	if ('' === $str) {
358	2	throw new Exception('you should use a valid charset');
359		}
360	2	$this->conversion_input_encoding = strtoupper($str);
361
362	2	return $this;
363		}
364		}
365

thephpleague / csv

Pull Request — master (#210)

RecordSet::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like