Reader::setHeaderOffset() - Code Metrics - Inspection of "Merge branch 'feature/php7'" - palmtreephp/csv - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 25c805...999286 )

by Andy

created 2019-12-28 15:04 UTC

Reader::setHeaderOffset() A

↳ Parent: Reader

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace Palmtree\Csv;

use Palmtree\Csv\Normalizer\NormalizerInterface;
use Palmtree\Csv\Normalizer\NullNormalizer;
use Palmtree\Csv\Row\Row;
use Palmtree\Csv\Util\StringUtil;

/**
 * Reads a CSV file by loading each line into memory one at a time.
 */
class Reader extends AbstractCsvDocument implements \Iterator
{
    /** @var string */
    private $defaultNormalizer = NullNormalizer::class;
    /** @var NormalizerInterface|null */
    private $headerNormalizer;
    /** @var NormalizerInterface[] */
    private $normalizers = [];
    /** @var Row|null */
    private $headers;
    /** @var Row */
    private $row;
    /** @var string|null */
    private $stripBom = StringUtil::BOM_UTF8;
    /** @var int */
    private $offset = 0;
    /** @var int */
    private $headerOffset = 0;

    public static function read(string $filePath, bool $hasHeaders = true): self
    {
        return new self($filePath, $hasHeaders);
    }

    public function getHeaders(): ?Row
    {
        if ($this->hasHeaders && $this->headers === null) {
            $this->rewind();
        }

        return $this->headers;
    }

    /**
     * @param string|int $key
     *
     * @return string|int
     */
    public function getHeader($key)
    {
        return $this->headers[$key] ?? $key;
    }

    public function setHeaderNormalizer(NormalizerInterface $headerNormalizer): self
    {
        $this->headerNormalizer = $headerNormalizer;

        return $this;
    }

    public function getHeaderNormalizer(): NormalizerInterface
    {
        if ($this->headerNormalizer === null) {
            $this->headerNormalizer = new NullNormalizer();
        }

        return $this->headerNormalizer;
    }

    public function addNormalizer(string $key, NormalizerInterface $normalizer): self
    {
        $this->normalizers[$key] = $normalizer;

        return $this;
    }

    public function addNormalizers(iterable $normalizers): self
    {
        foreach ($normalizers as $key => $normalizer) {
            $this->addNormalizer($key, $normalizer);
        }

        return $this;
    }

    /**
     * @param string|int $key
     */
    public function getNormalizer($key): NormalizerInterface
    {
        if ($this->hasHeaders && \is_int($key)) {
            $this->normalizers[$key] = $this->getHeaderNormalizer();
        }

        if (!isset($this->normalizers[$key])) {
            $class = $this->getDefaultNormalizer();

            $this->normalizers[$key] = new $class();
        }

        return $this->normalizers[$key];
    }

    /**
     * Reads the next line in the CSV file and returns a Row object from it.
     */
    private function getCurrentRow(): ?Row
    {
        $cells = $this->getDocument()->current();

        if (!\is_array($cells) || $cells == [null]) {
            return null;
        }

        if ($this->key() === 0 && $this->stripBom) {
            $stripped = StringUtil::stripBom($cells[0], $this->stripBom);

            if ($stripped !== $cells[0]) {
                $cells[0] = \trim($stripped, $this->enclosure);
            }
        }

        return new Row($cells, $this);
    }

    /**
     * @inheritDoc
     */
    public function current(): Row
    {
        return $this->row;
    }

    /**
     * @inheritDoc
     */
    public function next(): void
    {
        $this->getDocument()->next();
    }

    /**
     * @inheritDoc
     */
    public function key(): int
    {
        return $this->getDocument()->key();
    }

    /**
     * @inheritDoc
     */
    public function valid(): bool
    {
        $this->row = $this->getCurrentRow();

        return $this->row instanceof Row;
    }

    /**
     * @inheritDoc
     */
    public function rewind(): void
    {
        $this->getDocument()->rewind();

        $dataOffset = $this->offset + $this->headerOffset;
        if ($this->hasHeaders) {
            if ($this->headerOffset) {
                $this->getDocument()->seek($this->headerOffset);
            }

            // Set headers to null first so the header row is a zero-based array and can be used
            // to set the array keys of all other rows.
            $this->headers = null;
            $this->headers = $this->getCurrentRow();

            ++$dataOffset;
        }

        if ($dataOffset > 0) {
            $this->getDocument()->seek($dataOffset);
        }
    }

    public function setDefaultNormalizer(string $defaultNormalizer): self
    {
        $this->defaultNormalizer = $defaultNormalizer;

        return $this;
    }

    public function getDefaultNormalizer(): string
    {
        return $this->defaultNormalizer;
    }

    public function setStripBom(?string $stripBom): self
    {
        $this->stripBom = $stripBom;

        return $this;
    }

    public function setOffset(int $offset): self
    {
        $this->offset = $offset;

        return $this;
    }

    public function getOffset(): int
    {
        return $this->offset;
    }

    public function setHeaderOffset(int $headerOffset): self
    {
        $this->headerOffset = $headerOffset;

        return $this;
    }

    public function getHeaderOffset(): int
    {
        return $this->headerOffset;
    }

    public function toArray(): array
    {
        $result = [];
        foreach ($this as $row) {
            $result[] = $row->toArray();
        }

        return $result;
    }

    protected function getOpenMode(): string
    {
        return 'r';
    }
}


1		<?php
2
3		namespace Palmtree\Csv;
4
5		use Palmtree\Csv\Normalizer\NormalizerInterface;
6		use Palmtree\Csv\Normalizer\NullNormalizer;
7		use Palmtree\Csv\Row\Row;
8		use Palmtree\Csv\Util\StringUtil;
9
10		/**
11		* Reads a CSV file by loading each line into memory one at a time.
12		*/
13		class Reader extends AbstractCsvDocument implements \Iterator
14		{
15		/** @var string */
16		private $defaultNormalizer = NullNormalizer::class;
17		/** @var NormalizerInterface\|null */
18		private $headerNormalizer;
19		/** @var NormalizerInterface[] */
20		private $normalizers = [];
21		/** @var Row\|null */
22		private $headers;
23		/** @var Row */
24		private $row;
25		/** @var string\|null */
26		private $stripBom = StringUtil::BOM_UTF8;
27		/** @var int */
28		private $offset = 0;
29		/** @var int */
30		private $headerOffset = 0;
31
32		public static function read(string $filePath, bool $hasHeaders = true): self
33		{
34		return new self($filePath, $hasHeaders);
35		}
36
37	3	public function getHeaders(): ?Row
38		{
39	3	if ($this->hasHeaders && $this->headers === null) {
40	3	$this->rewind();
41		}
42
43	3	return $this->headers;
44		}
45
46		/**
47		* @param string\|int $key
48		*
49		* @return string\|int
50		*/
51	10	public function getHeader($key)
52		{
53	10	return $this->headers[$key] ?? $key;
54		}
55
56		public function setHeaderNormalizer(NormalizerInterface $headerNormalizer): self
57		{
58		$this->headerNormalizer = $headerNormalizer;
59
60		return $this;
61		}
62
63	8	public function getHeaderNormalizer(): NormalizerInterface
64		{
65	8	if ($this->headerNormalizer === null) {
66	8	$this->headerNormalizer = new NullNormalizer();
67		}
68
69	8	return $this->headerNormalizer;
70		}
71
72		public function addNormalizer(string $key, NormalizerInterface $normalizer): self
73		{
74		$this->normalizers[$key] = $normalizer;
75
76		return $this;
77		}
78
79		public function addNormalizers(iterable $normalizers): self
80		{
81		foreach ($normalizers as $key => $normalizer) {
82		$this->addNormalizer($key, $normalizer);
83		}
84
85		return $this;
86		}
87
88		/**
89		* @param string\|int $key
90		*/
91	10	public function getNormalizer($key): NormalizerInterface
92		{
93	10	if ($this->hasHeaders && \is_int($key)) {
94	8	$this->normalizers[$key] = $this->getHeaderNormalizer();
95		}
96
97	10	if (!isset($this->normalizers[$key])) {
98	5	$class = $this->getDefaultNormalizer();
99
100	5	$this->normalizers[$key] = new $class();
101		}
102
103	10	return $this->normalizers[$key];
104		}
105
106		/**
107		* Reads the next line in the CSV file and returns a Row object from it.
108		*/
109	7	private function getCurrentRow(): ?Row
110		{
111	7	$cells = $this->getDocument()->current();
112
113	7	if (!\is_array($cells) \|\| $cells == [null]) {
114	5	return null;
115		}
116
117	7	if ($this->key() === 0 && $this->stripBom) {
118	5	$stripped = StringUtil::stripBom($cells[0], $this->stripBom);
119
120	5	if ($stripped !== $cells[0]) {
121	1	$cells[0] = \trim($stripped, $this->enclosure);
122		}
123		}
124
125	7	return new Row($cells, $this);
126		}
127
128		/**
129		* @inheritDoc
130		*/
131	5	public function current(): Row
132		{
133	5	return $this->row;
134		}
135
136		/**
137		* @inheritDoc
138		*/
139	5	public function next(): void
140		{
141	5	$this->getDocument()->next();
142	5	}
143
144		/**
145		* @inheritDoc
146		*/
147	7	public function key(): int
148		{
149	7	return $this->getDocument()->key();
150		}
151
152		/**
153		* @inheritDoc
154		*/
155	5	public function valid(): bool
156		{
157	5	$this->row = $this->getCurrentRow();
158
159	5	return $this->row instanceof Row;
160		}
161
162		/**
163		* @inheritDoc
164		*/
165	7	public function rewind(): void
166		{
167	7	$this->getDocument()->rewind();
168
169	7	$dataOffset = $this->offset + $this->headerOffset;
170	7	if ($this->hasHeaders) {
171	5	if ($this->headerOffset) {
172	1	$this->getDocument()->seek($this->headerOffset);
173		}
174
175		// Set headers to null first so the header row is a zero-based array and can be used
176		// to set the array keys of all other rows.
177	5	$this->headers = null;
178	5	$this->headers = $this->getCurrentRow();
179
180	5	++$dataOffset;
181		}
182
183	7	if ($dataOffset > 0) {
184	5	$this->getDocument()->seek($dataOffset);
185		}
186	7	}
187
188		public function setDefaultNormalizer(string $defaultNormalizer): self
189		{
190		$this->defaultNormalizer = $defaultNormalizer;
191
192		return $this;
193		}
194
195	5	public function getDefaultNormalizer(): string
196		{
197	5	return $this->defaultNormalizer;
198		}
199
200	1	public function setStripBom(?string $stripBom): self
201		{
202	1	$this->stripBom = $stripBom;
203
204	1	return $this;
205		}
206
207	1	public function setOffset(int $offset): self
208		{
209	1	$this->offset = $offset;
210
211	1	return $this;
212		}
213
214		public function getOffset(): int
215		{
216		return $this->offset;
217		}
218
219	1	public function setHeaderOffset(int $headerOffset): self
220		{
221	1	$this->headerOffset = $headerOffset;
222
223	1	return $this;
224		}
225
226		public function getHeaderOffset(): int
227		{
228		return $this->headerOffset;
229		}
230
231	3	public function toArray(): array
232		{
233	3	$result = [];
234	3	foreach ($this as $row) {
235	3	$result[] = $row->toArray();
236		}
237
238	3	return $result;
239		}
240
241	7	protected function getOpenMode(): string
242		{
243	7	return 'r';
244		}
245		}
246

palmtreephp / csv

Push — master ( 25c805...999286 )

Reader::setHeaderOffset() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like