EmptyEscapeParser::extractRecord() - Code Metrics - thephpleague/csv - Measure and Improve Code Quality continuously with Scrutinizer

EmptyEscapeParser::extractRecord() A
last analyzed 2020-11-03 01:53 UTC

↳ Parent: EmptyEscapeParser

Complexity

Conditions	5
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	5

Importance

Changes

Metric	Value
cc	5
nc	8
nop	0
dl	0
loc	21
ccs	13
cts	13
cp	1
crap	5
rs	9.2728
c	0
b	0
f	0

<?php

/**
 * League.Csv (https://csv.thephpleague.com)
 *
 * (c) Ignace Nyamagana Butera <[email protected]>
 *
 * 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\Polyfill;

use Generator;
use League\Csv\Stream;
use SplFileObject;
use TypeError;
use function explode;
use function get_class;
use function in_array;
use function ltrim;
use function rtrim;
use function sprintf;
use function str_replace;
use function substr;

/**
 * A Polyfill to PHP's SplFileObject to enable parsing the CSV document
 * without taking into account the escape character.
 *
 * @see https://php.net/manual/en/function.fgetcsv.php
 * @see https://php.net/manual/en/function.fgets.php
 * @see https://tools.ietf.org/html/rfc4180
 * @see http://edoceo.com/utilitas/csv-file-format
 *
 * @internal used internally to parse a CSV document without using the escape character
 */
final class EmptyEscapeParser
{
    /**
     * @internal
     */
    const FIELD_BREAKS = [false, '', "\r\n", "\n", "\r"];

    /**
     * @var SplFileObject|Stream
     */
    private static $document;

    /**
     * @var string
     */
    private static $delimiter;

    /**
     * @var string
     */
    private static $enclosure;

    /**
     * @var string
     */
    private static $trim_mask;

    /**
     * @var string|false
     */
    private static $line;

    /**
     * @codeCoverageIgnore
     */
    private function __construct()
    {
    }

    /**
     * Converts the document into a CSV record iterator.
     *
     * In PHP7.4+ you'll be able to do
     *
     * <code>
     * $file = new SplFileObject('/path/to/file.csv', 'r');
     * $file->setFlags(SplFileObject::READ_CSV | SplFileObject::READ_AHEAD | SplFileObject::SKIP_EMPTY);
     * $file->setCsvControl($delimiter, $enclosure, '');
     * foreach ($file as $record) {
     *    //$record escape mechanism is blocked by the empty string
     * }
     * </code>
     *
     * In PHP7.3- you can do
     *
     * <code>
     * $file = new SplFileObject('/path/to/file.csv', 'r');
     * $it = EmptyEscapeParser::parse($file); //parsing will be done while ignoring the escape character value.
     * foreach ($it as $record) {
     *    //fgetcsv is not directly use hence the escape char is not taken into account
     * }
     * </code>
     *
     * Each record array contains strings elements.
     *
     * @param SplFileObject|Stream $document
     *
     * @return Generator|array[]
     */
    public static function parse($document): Generator
    {
        self::$document = self::filterDocument($document);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        list(self::$delimiter, self::$enclosure, ) = self::$document->getCsvControl();
        self::$trim_mask = str_replace([self::$delimiter, self::$enclosure], '', " \t\0\x0B");
        self::$document->setFlags(0);
        self::$document->rewind();
        while (self::$document->valid()) {
            $record = self::extractRecord();
            if ([null] === $record || !in_array(null, $record, true)) {
                yield $record;
            }
        }
    }

    /**
     * Filters the submitted document.
     *
     * @return SplFileObject|Stream
     */
    private static function filterDocument(object $document)
    {
        if ($document instanceof Stream || $document instanceof SplFileObject) {
            return $document;
        }

        throw new TypeError(sprintf(
            '%s::parse expects parameter 1 to be a %s or a SplFileObject object, %s given',
            self::class,
            Stream::class,
            get_class($document)
        ));
    }

    /**
     * Extracts a record form the CSV document.
     */
    private static function extractRecord(): array
    {
        $record = [];
        self::$line = self::$document->fgets();
        do {
            $is_field_enclosed = false;
            $buffer = '';
            if (false !== self::$line) {
                $buffer = ltrim(self::$line, self::$trim_mask);
            }

            if (($buffer[0] ?? '') === self::$enclosure) {
                $is_field_enclosed = true;
                self::$line = $buffer;
            }

            $record[] = $is_field_enclosed ? self::extractEnclosedFieldContent() : self::extractFieldContent();
        } while (false !== self::$line);

        return $record;
    }

    /**
     * Extracts the content from a field without enclosure.
     *
     * - Field content can not spread on multiple document lines.
     * - Content must be preserved.
     * - Trailing line-breaks must be removed.
     *
     * @return string|null
     */
    private static function extractFieldContent()
    {
        if (in_array(self::$line, self::FIELD_BREAKS, true)) {
            self::$line = false;

            return null;
        }

        /** @var array<string> $result */
        $result = explode(self::$delimiter, self::$line, 2);
        /** @var string $content */
        [$content, $remainder] = $result + [1 => false];


        /* @var string|false line */
        self::$line = $remainder;
        if (false === self::$line) {
            return rtrim($content, "\r\n");
        }

        return $content;
    }

    /**
     * Extracts the content from a field with enclosure.
     *
     * - Field content can spread on multiple document lines.
     * - Content between consecutive enclosure characters must be preserved.
     * - Double enclosure sequence must be replaced by single enclosure character.
     * - Trailing line break must be removed if they are not part of the field content.
     * - Invalid field content is treated as per fgetcsv behavior.
     *
     * @return string|null
     */
    private static function extractEnclosedFieldContent()
    {
        if (false !== self::$line && self::$line[0] === self::$enclosure) {
            self::$line = substr(self::$line, 1);
        }

        $content = '';
        while (false !== self::$line) {
            /** @var array $result */
            $result = explode(self::$enclosure, self::$line, 2);
            [$buffer, $remainder] = $result + [1 => false];

            $content .= $buffer;
            self::$line = $remainder;
            if (false !== self::$line) {
                break;
            }

            if (self::$document->valid()) {
                self::$line = self::$document->fgets();
                continue;
            }

            if ($buffer === rtrim($content, "\r\n")) {
                return null;
            }
        }

        if (in_array(self::$line, self::FIELD_BREAKS, true)) {
            self::$line = false;
            if (!self::$document->valid()) {
                return $content;
            }

            return rtrim($content, "\r\n");
        }

        $char = self::$line[0] ?? '';
        if ($char === self::$delimiter) {
            self::$line = substr(self::$line, 1);

            return $content;
        }

        if ($char === self::$enclosure) {
            return $content.self::$enclosure.self::extractEnclosedFieldContent();
        }

        return $content.self::extractFieldContent();
    }
}


1		<?php
2
3		/**
4		* League.Csv (https://csv.thephpleague.com)
5		*
6		* (c) Ignace Nyamagana Butera <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		declare(strict_types=1);
13
14		namespace League\Csv\Polyfill;
15
16		use Generator;
17		use League\Csv\Stream;
18		use SplFileObject;
19		use TypeError;
20		use function explode;
21		use function get_class;
22		use function in_array;
23		use function ltrim;
24		use function rtrim;
25		use function sprintf;
26		use function str_replace;
27		use function substr;
28
29		/**
30		* A Polyfill to PHP's SplFileObject to enable parsing the CSV document
31		* without taking into account the escape character.
32		*
33		* @see https://php.net/manual/en/function.fgetcsv.php
34		* @see https://php.net/manual/en/function.fgets.php
35		* @see https://tools.ietf.org/html/rfc4180
36		* @see http://edoceo.com/utilitas/csv-file-format
37		*
38		* @internal used internally to parse a CSV document without using the escape character
39		*/
40		final class EmptyEscapeParser
41		{
42		/**
43		* @internal
44		*/
45		const FIELD_BREAKS = [false, '', "\r\n", "\n", "\r"];
46
47		/**
48		* @var SplFileObject\|Stream
49		*/
50		private static $document;
51
52		/**
53		* @var string
54		*/
55		private static $delimiter;
56
57		/**
58		* @var string
59		*/
60		private static $enclosure;
61
62		/**
63		* @var string
64		*/
65		private static $trim_mask;
66
67		/**
68		* @var string\|false
69		*/
70		private static $line;
71
72		/**
73		* @codeCoverageIgnore
74		*/
75		private function __construct()
76		{
77		}
78
79		/**
80		* Converts the document into a CSV record iterator.
81		*
82		* In PHP7.4+ you'll be able to do
83		*
84		* <code>
85		* $file = new SplFileObject('/path/to/file.csv', 'r');
86		* $file->setFlags(SplFileObject::READ_CSV \| SplFileObject::READ_AHEAD \| SplFileObject::SKIP_EMPTY);
87		* $file->setCsvControl($delimiter, $enclosure, '');
88		* foreach ($file as $record) {
89		* //$record escape mechanism is blocked by the empty string
90		* }
91		* </code>
92		*
93		* In PHP7.3- you can do
94		*
95		* <code>
96		* $file = new SplFileObject('/path/to/file.csv', 'r');
97		* $it = EmptyEscapeParser::parse($file); //parsing will be done while ignoring the escape character value.
98		* foreach ($it as $record) {
99		* //fgetcsv is not directly use hence the escape char is not taken into account
100		* }
101		* </code>
102		*
103		* Each record array contains strings elements.
104		*
105		* @param SplFileObject\|Stream $document
106		*
107		* @return Generator\|array[]
108		*/
109	37	public static function parse($document): Generator
110		{
111	37	self::$document = self::filterDocument($document);
		0 ignored issues – show Documentation introduced 2020-02-18 20:29 UTC by Report Bug Copy Issue Report `$document` is of type `object<SplFileObject>\|object<League\Csv\Stream>`, but the function expects a `object<League\Csv\Polyfill\object>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
112	34	list(self::$delimiter, self::$enclosure, ) = self::$document->getCsvControl();
113	34	self::$trim_mask = str_replace([self::$delimiter, self::$enclosure], '', " \t\0\x0B");
114	34	self::$document->setFlags(0);
115	34	self::$document->rewind();
116	34	while (self::$document->valid()) {
117	34	$record = self::extractRecord();
118	34	if ([null] === $record \|\| !in_array(null, $record, true)) {
119	32	yield $record;
120		}
121		}
122	34	}
123
124		/**
125		* Filters the submitted document.
126		*
127		* @return SplFileObject\|Stream
128		*/
129	6	private static function filterDocument(object $document)
130		{
131	6	if ($document instanceof Stream \|\| $document instanceof SplFileObject) {
132	3	return $document;
133		}
134
135	3	throw new TypeError(sprintf(
136	3	'%s::parse expects parameter 1 to be a %s or a SplFileObject object, %s given',
137	3	self::class,
138	3	Stream::class,
139	3	get_class($document)
140		));
141		}
142
143		/**
144		* Extracts a record form the CSV document.
145		*/
146	34	private static function extractRecord(): array
147		{
148	34	$record = [];
149	34	self::$line = self::$document->fgets();
150		do {
151	34	$is_field_enclosed = false;
152	34	$buffer = '';
153	34	if (false !== self::$line) {
154	34	$buffer = ltrim(self::$line, self::$trim_mask);
155		}
156
157	34	if (($buffer[0] ?? '') === self::$enclosure) {
158	24	$is_field_enclosed = true;
159	24	self::$line = $buffer;
160		}
161
162	34	$record[] = $is_field_enclosed ? self::extractEnclosedFieldContent() : self::extractFieldContent();
163	34	} while (false !== self::$line);
164
165	34	return $record;
166		}
167
168		/**
169		* Extracts the content from a field without enclosure.
170		*
171		* - Field content can not spread on multiple document lines.
172		* - Content must be preserved.
173		* - Trailing line-breaks must be removed.
174		*
175		* @return string\|null
176		*/
177	34	private static function extractFieldContent()
178		{
179	34	if (in_array(self::$line, self::FIELD_BREAKS, true)) {
180	6	self::$line = false;
181
182	6	return null;
183		}
184
185		/** @var array<string> $result */
186	31	$result = explode(self::$delimiter, self::$line, 2);
187		/** @var string $content */
188	31	[$content, $remainder] = $result + [1 => false];
		0 ignored issues – show Bug introduced 2020-02-18 20:29 UTC by Report Bug Copy Issue Report The variable `$content` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2020-02-18 20:29 UTC by Report Bug Copy Issue Report The variable `$remainder` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
189
190		/* @var string\|false line */
191	31	self::$line = $remainder;
192	31	if (false === self::$line) {
193	23	return rtrim($content, "\r\n");
194		}
195
196	31	return $content;
197		}
198
199		/**
200		* Extracts the content from a field with enclosure.
201		*
202		* - Field content can spread on multiple document lines.
203		* - Content between consecutive enclosure characters must be preserved.
204		* - Double enclosure sequence must be replaced by single enclosure character.
205		* - Trailing line break must be removed if they are not part of the field content.
206		* - Invalid field content is treated as per fgetcsv behavior.
207		*
208		* @return string\|null
209		*/
210	24	private static function extractEnclosedFieldContent()
211		{
212	24	if (false !== self::$line && self::$line[0] === self::$enclosure) {
213	24	self::$line = substr(self::$line, 1);
214		}
215
216	24	$content = '';
217	24	while (false !== self::$line) {
218		/** @var array $result */
219	24	$result = explode(self::$enclosure, self::$line, 2);
220	24	[$buffer, $remainder] = $result + [1 => false];
		0 ignored issues – show Bug introduced 2019-06-04 20:03 UTC by Report Bug Copy Issue Report The variable `$buffer` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2019-06-04 20:03 UTC by Report Bug Copy Issue Report The variable `$remainder` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
221	24	$content .= $buffer;
222	24	self::$line = $remainder;
223	24	if (false !== self::$line) {
224	18	break;
225		}
226
227	12	if (self::$document->valid()) {
228	8	self::$line = self::$document->fgets();
229	8	continue;
230		}
231
232	6	if ($buffer === rtrim($content, "\r\n")) {
233	2	return null;
234		}
235		}
236
237	22	if (in_array(self::$line, self::FIELD_BREAKS, true)) {
238	11	self::$line = false;
239	11	if (!self::$document->valid()) {
240	9	return $content;
241		}
242
243	7	return rtrim($content, "\r\n");
244		}
245
246	18	$char = self::$line[0] ?? '';
247	18	if ($char === self::$delimiter) {
248	14	self::$line = substr(self::$line, 1);
249
250	14	return $content;
251		}
252
253	15	if ($char === self::$enclosure) {
254	9	return $content.self::$enclosure.self::extractEnclosedFieldContent();
255		}
256
257	6	return $content.self::extractFieldContent();
258		}
259		}
260

thephpleague / csv

EmptyEscapeParser::extractRecord() A last analyzed 2020-11-03 01:53 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

EmptyEscapeParser::extractRecord() A
last analyzed 2020-11-03 01:53 UTC