Stream::setCsvControl() - Code Metrics - Inspection of "Prepare 9.3.0 release" - thephpleague/csv - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( da1a11...3ae0ef )

by ignace nyamagana

created 2019-07-16 10:24 UTC

Stream::setCsvControl() A

↳ Parent: Stream

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
nc	1
nop	3
dl	0
loc	4
ccs	3
cts	3
cp	1
crap	1
rs	10
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;

use SeekableIterator;
use SplFileObject;
use TypeError;
use function array_keys;
use function array_walk_recursive;
use function fclose;
use function feof;
use function fflush;
use function fgetcsv;
use function fgets;
use function fopen;
use function fpassthru;
use function fputcsv;
use function fread;
use function fseek;
use function fwrite;
use function get_resource_type;
use function gettype;
use function is_resource;
use function rewind;
use function sprintf;
use function stream_filter_append;
use function stream_filter_remove;
use function stream_get_meta_data;
use function strlen;
use const PHP_VERSION_ID;
use const SEEK_SET;

/**
 * An object oriented API to handle a PHP stream resource.
 *
 * @internal used internally to iterate over a stream resource
 */
class Stream implements SeekableIterator
{
    /**
     * Attached filters.
     *
     * @var resource[]
     */
    protected $filters = [];

    /**
     * stream resource.
     *
     * @var resource
     */
    protected $stream;

    /**
     * Tell whether the stream should be closed on object destruction.
     *
     * @var bool
     */
    protected $should_close_stream = false;

    /**
     * Current iterator value.
     *
     * @var mixed
     */
    protected $value;

    /**
     * Current iterator key.
     *
     * @var int
     */
    protected $offset;

    /**
     * Flags for the Document.
     *
     * @var int
     */
    protected $flags = 0;

    /**
     * the field delimiter (one character only).
     *
     * @var string
     */
    protected $delimiter = ',';

    /**
     * the field enclosure character (one character only).
     *
     * @var string
     */
    protected $enclosure = '"';

    /**
     * the field escape character (one character only).
     *
     * @var string
     */
    protected $escape = '\\';

    /**
     * Tell whether the current stream is seekable;.
     *
     * @var bool
     */
    protected $is_seekable = false;

    /**
     * New instance.
     *
     * @param resource $resource stream type resource
     */
    public function __construct($resource)
    {
        if (!is_resource($resource)) {
            throw new TypeError(sprintf('Argument passed must be a stream resource, %s given', gettype($resource)));
        }

        if ('stream' !== ($type = get_resource_type($resource))) {
            throw new TypeError(sprintf('Argument passed must be a stream resource, %s resource given', $type));
        }

        $this->is_seekable = stream_get_meta_data($resource)['seekable'];
        $this->stream = $resource;
    }

    /**
     * {@inheritdoc}
     */
    public function __destruct()
    {
        $walker = static function ($filter): bool {
            return @stream_filter_remove($filter);
        };

        array_walk_recursive($this->filters, $walker);

        if ($this->should_close_stream && is_resource($this->stream)) {
            fclose($this->stream);
        }

        unset($this->stream);
    }

    /**
     * {@inheritdoc}
     */
    public function __clone()
    {
        throw new Exception(sprintf('An object of class %s cannot be cloned', static::class));
    }

    /**
     * {@inheritdoc}
     */
    public function __debugInfo()
    {
        return stream_get_meta_data($this->stream) + [
            'delimiter' => $this->delimiter,
            'enclosure' => $this->enclosure,
            'escape' => $this->escape,
            'stream_filters' => array_keys($this->filters),
        ];
    }

    /**
     * Return a new instance from a file path.
     *
     * @param resource|null $context
     *
     * @throws Exception if the stream resource can not be created
     *
     * @return static
     */
    public static function createFromPath(string $path, string $open_mode = 'r', $context = null)
    {
        $args = [$path, $open_mode];
        if (null !== $context) {
            $args[] = false;
            $args[] = $context;
        }

        if (!$resource = @fopen(...$args)) {
            throw new Exception(sprintf('`%s`: failed to open stream: No such file or directory', $path));
        }

        $instance = new static($resource);
        $instance->should_close_stream = true;

        return $instance;
    }

    /**
     * Return a new instance from a string.
     *
     * @return static
     */
    public static function createFromString(string $content = '')
    {
        $resource = fopen('php://temp', 'r+');
        fwrite($resource, $content);

        $instance = new static($resource);
        $instance->should_close_stream = true;

        return $instance;
    }

    /**
     * Return the URI of the underlying stream.
     */
    public function getPathname(): string
    {
        return stream_get_meta_data($this->stream)['uri'];
    }

    /**
     * append a filter.
     *
     * @see http://php.net/manual/en/function.stream-filter-append.php
     *
     * @param  null|mixed $params
     * @throws Exception  if the filter can not be appended
     */
    public function appendFilter(string $filtername, int $read_write, $params = null)
    {
        $res = @stream_filter_append($this->stream, $filtername, $read_write, $params);
        if (is_resource($res)) {
            $this->filters[$filtername][] = $res;
            return;
        }

        throw new Exception(sprintf('unable to locate filter `%s`', $filtername));
    }

    /**
     * Set CSV control.
     *
     * @see http://php.net/manual/en/splfileobject.setcsvcontrol.php
     */
    public function setCsvControl(string $delimiter = ',', string $enclosure = '"', string $escape = '\\')
    {
        list($this->delimiter, $this->enclosure, $this->escape) = $this->filterControl($delimiter, $enclosure, $escape, __METHOD__);
    }

    /**
     * Filter Csv control characters.
     *
     * @throws Exception If the Csv control character is not one character only.
     */
    protected function filterControl(string $delimiter, string $enclosure, string $escape, string $caller): array
    {
        if (1 !== strlen($delimiter)) {
            throw new Exception(sprintf('%s() expects delimiter to be a single character', $caller));
        }

        if (1 !== strlen($enclosure)) {
            throw new Exception(sprintf('%s() expects enclosure to be a single character', $caller));
        }

        if (1 === strlen($escape) || ('' === $escape && 70400 <= PHP_VERSION_ID)) {
            return [$delimiter, $enclosure, $escape];
        }

        throw new Exception(sprintf('%s() expects escape to be a single character', $caller));
    }

    /**
     * Set CSV control.
     *
     * @see http://php.net/manual/en/splfileobject.getcsvcontrol.php
     *
     * @return string[]
     */
    public function getCsvControl()
    {
        return [$this->delimiter, $this->enclosure, $this->escape];
    }

    /**
     * Set CSV stream flags.
     *
     * @see http://php.net/manual/en/splfileobject.setflags.php
     */
    public function setFlags(int $flags)
    {
        $this->flags = $flags;
    }

    /**
     * Write a field array as a CSV line.
     *
     * @see http://php.net/manual/en/splfileobject.fputcsv.php
     *
     * @return int|bool
     */
    public function fputcsv(array $fields, string $delimiter = ',', string $enclosure = '"', string $escape = '\\')
    {
        $controls = $this->filterControl($delimiter, $enclosure, $escape, __METHOD__);

        return fputcsv($this->stream, $fields, ...$controls);
    }

    /**
     * Get line number.
     *
     * @see http://php.net/manual/en/splfileobject.key.php
     *
     * @return int
     */
    public function key()
    {
        return $this->offset;
    }

    /**
     * Read next line.
     *
     * @see http://php.net/manual/en/splfileobject.next.php
     */
    public function next()
    {
        $this->value = false;
        $this->offset++;
    }

    /**
     * Rewind the file to the first line.
     *
     * @see http://php.net/manual/en/splfileobject.rewind.php
     *
     * @throws Exception if the stream resource is not seekable
     */
    public function rewind()
    {
        if (!$this->is_seekable) {
            throw new Exception('stream does not support seeking');
        }

        rewind($this->stream);
        $this->offset = 0;
        $this->value = false;
        if ($this->flags & SplFileObject::READ_AHEAD) {
            $this->current();
        }
    }

    /**
     * Not at EOF.
     *
     * @see http://php.net/manual/en/splfileobject.valid.php
     *
     * @return bool
     */
    public function valid()
    {
        if ($this->flags & SplFileObject::READ_AHEAD) {
            return $this->current() !== false;
        }

        return !feof($this->stream);
    }

    /**
     * Retrieves the current line of the file.
     *
     * @see http://php.net/manual/en/splfileobject.current.php
     */
    public function current()
    {
        if (false !== $this->value) {
            return $this->value;
        }

        $this->value = $this->getCurrentRecord();

        return $this->value;
    }

    /**
     * Retrieves the current line as a CSV Record.
     *
     * @return array|bool
     */
    protected function getCurrentRecord()
    {
        do {
            $ret = fgetcsv($this->stream, 0, $this->delimiter, $this->enclosure, $this->escape);
        } while ($this->flags & SplFileObject::SKIP_EMPTY && $ret !== false && $ret[0] === null);

        return $ret;
    }

    /**
     * Seek to specified line.
     *
     * @see http://php.net/manual/en/splfileobject.seek.php
     *
     * @param  int       $position
     * @throws Exception if the position is negative
     */
    public function seek($position)
    {
        if ($position < 0) {
            throw new Exception(sprintf('%s() can\'t seek stream to negative line %d', __METHOD__, $position));
        }

        $this->rewind();
        while ($this->key() !== $position && $this->valid()) {
            $this->current();
            $this->next();
        }

        if (0 !== $position) {
            $this->offset--;
        }

        $this->current();
    }

    /**
     * Output all remaining data on a file pointer.
     *
     * @see http://php.net/manual/en/splfileobject.fpatssthru.php
     *
     * @return int
     */
    public function fpassthru()
    {
        return fpassthru($this->stream);
    }

    /**
     * Read from file.
     *
     * @see http://php.net/manual/en/splfileobject.fread.php
     *
     * @param int $length The number of bytes to read
     *
     * @return string|false
     */
    public function fread($length)
    {
        return fread($this->stream, $length);
    }

    /**
     * Gets a line from file.
     *
     * @see http://php.net/manual/en/splfileobject.fgets.php
     *
     * @return string|false
     */
    public function fgets()
    {
        return fgets($this->stream);
    }

    /**
     * Seek to a position.
     *
     * @see http://php.net/manual/en/splfileobject.fseek.php
     *
     * @throws Exception if the stream resource is not seekable
     *
     * @return int
     */
    public function fseek(int $offset, int $whence = SEEK_SET)
    {
        if (!$this->is_seekable) {
            throw new Exception('stream does not support seeking');
        }

        return fseek($this->stream, $offset, $whence);
    }

    /**
     * Write to stream.
     *
     * @see http://php.net/manual/en/splfileobject.fwrite.php
     *
     * @return int|bool
     */
    public function fwrite(string $str, int $length = null)
    {
        $args = [$this->stream, $str];
        if (null !== $length) {
            $args[] = $length;
        }

        return fwrite(...$args);
    }

    /**
     * Flushes the output to a file.
     *
     * @see http://php.net/manual/en/splfileobject.fwrite.php
     *
     * @return bool
     */
    public function fflush()
    {
        return fflush($this->stream);
    }
}


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;
15
16		use SeekableIterator;
17		use SplFileObject;
18		use TypeError;
19		use function array_keys;
20		use function array_walk_recursive;
21		use function fclose;
22		use function feof;
23		use function fflush;
24		use function fgetcsv;
25		use function fgets;
26		use function fopen;
27		use function fpassthru;
28		use function fputcsv;
29		use function fread;
30		use function fseek;
31		use function fwrite;
32		use function get_resource_type;
33		use function gettype;
34		use function is_resource;
35		use function rewind;
36		use function sprintf;
37		use function stream_filter_append;
38		use function stream_filter_remove;
39		use function stream_get_meta_data;
40		use function strlen;
41		use const PHP_VERSION_ID;
42		use const SEEK_SET;
43
44		/**
45		* An object oriented API to handle a PHP stream resource.
46		*
47		* @internal used internally to iterate over a stream resource
48		*/
49		class Stream implements SeekableIterator
50		{
51		/**
52		* Attached filters.
53		*
54		* @var resource[]
55		*/
56		protected $filters = [];
57
58		/**
59		* stream resource.
60		*
61		* @var resource
62		*/
63		protected $stream;
64
65		/**
66		* Tell whether the stream should be closed on object destruction.
67		*
68		* @var bool
69		*/
70		protected $should_close_stream = false;
71
72		/**
73		* Current iterator value.
74		*
75		* @var mixed
76		*/
77		protected $value;
78
79		/**
80		* Current iterator key.
81		*
82		* @var int
83		*/
84		protected $offset;
85
86		/**
87		* Flags for the Document.
88		*
89		* @var int
90		*/
91		protected $flags = 0;
92
93		/**
94		* the field delimiter (one character only).
95		*
96		* @var string
97		*/
98		protected $delimiter = ',';
99
100		/**
101		* the field enclosure character (one character only).
102		*
103		* @var string
104		*/
105		protected $enclosure = '"';
106
107		/**
108		* the field escape character (one character only).
109		*
110		* @var string
111		*/
112		protected $escape = '\\';
113
114		/**
115		* Tell whether the current stream is seekable;.
116		*
117		* @var bool
118		*/
119		protected $is_seekable = false;
120
121		/**
122		* New instance.
123		*
124		* @param resource $resource stream type resource
125		*/
126	51	public function __construct($resource)
127		{
128	51	if (!is_resource($resource)) {
129	3	throw new TypeError(sprintf('Argument passed must be a stream resource, %s given', gettype($resource)));
130		}
131
132	48	if ('stream' !== ($type = get_resource_type($resource))) {
133	3	throw new TypeError(sprintf('Argument passed must be a stream resource, %s resource given', $type));
134		}
135
136	45	$this->is_seekable = stream_get_meta_data($resource)['seekable'];
137	45	$this->stream = $resource;
138	45	}
139
140		/**
141		* {@inheritdoc}
142		*/
143		public function __destruct()
144		{
145	45	$walker = static function ($filter): bool {
146	12	return @stream_filter_remove($filter);
147	45	};
148
149	45	array_walk_recursive($this->filters, $walker);
150
151	45	if ($this->should_close_stream && is_resource($this->stream)) {
152	30	fclose($this->stream);
153		}
154
155	45	unset($this->stream);
156	45	}
157
158		/**
159		* {@inheritdoc}
160		*/
161	3	public function __clone()
162		{
163	3	throw new Exception(sprintf('An object of class %s cannot be cloned', static::class));
164		}
165
166		/**
167		* {@inheritdoc}
168		*/
169	3	public function __debugInfo()
170		{
171	3	return stream_get_meta_data($this->stream) + [
172	3	'delimiter' => $this->delimiter,
173	3	'enclosure' => $this->enclosure,
174	3	'escape' => $this->escape,
175	3	'stream_filters' => array_keys($this->filters),
176		];
177		}
178
179		/**
180		* Return a new instance from a file path.
181		*
182		* @param resource\|null $context
183		*
184		* @throws Exception if the stream resource can not be created
185		*
186		* @return static
187		*/
188	21	public static function createFromPath(string $path, string $open_mode = 'r', $context = null)
189		{
190	21	$args = [$path, $open_mode];
191	21	if (null !== $context) {
192	3	$args[] = false;
193	3	$args[] = $context;
194		}
195
196	21	if (!$resource = @fopen(...$args)) {
197	6	throw new Exception(sprintf('`%s`: failed to open stream: No such file or directory', $path));
198		}
199
200	15	$instance = new static($resource);
201	15	$instance->should_close_stream = true;
202
203	15	return $instance;
204		}
205
206		/**
207		* Return a new instance from a string.
208		*
209		* @return static
210		*/
211	18	public static function createFromString(string $content = '')
212		{
213	18	$resource = fopen('php://temp', 'r+');
214	18	fwrite($resource, $content);
215
216	18	$instance = new static($resource);
217	18	$instance->should_close_stream = true;
218
219	18	return $instance;
220		}
221
222		/**
223		* Return the URI of the underlying stream.
224		*/
225	12	public function getPathname(): string
226		{
227	12	return stream_get_meta_data($this->stream)['uri'];
228		}
229
230		/**
231		* append a filter.
232		*
233		* @see http://php.net/manual/en/function.stream-filter-append.php
234		*
235		* @param null\|mixed $params
236		* @throws Exception if the filter can not be appended
237		*/
238	18	public function appendFilter(string $filtername, int $read_write, $params = null)
239		{
240	18	$res = @stream_filter_append($this->stream, $filtername, $read_write, $params);
241	18	if (is_resource($res)) {
242	12	$this->filters[$filtername][] = $res;
243	12	return;
244		}
245
246	6	throw new Exception(sprintf('unable to locate filter `%s`', $filtername));
247		}
248
249		/**
250		* Set CSV control.
251		*
252		* @see http://php.net/manual/en/splfileobject.setcsvcontrol.php
253		*/
254	24	public function setCsvControl(string $delimiter = ',', string $enclosure = '"', string $escape = '\\')
255		{
256	24	list($this->delimiter, $this->enclosure, $this->escape) = $this->filterControl($delimiter, $enclosure, $escape, __METHOD__);
257	21	}
258
259		/**
260		* Filter Csv control characters.
261		*
262		* @throws Exception If the Csv control character is not one character only.
263		*/
264	45	protected function filterControl(string $delimiter, string $enclosure, string $escape, string $caller): array
265		{
266	45	if (1 !== strlen($delimiter)) {
267	6	throw new Exception(sprintf('%s() expects delimiter to be a single character', $caller));
268		}
269
270	42	if (1 !== strlen($enclosure)) {
271	3	throw new Exception(sprintf('%s() expects enclosure to be a single character', $caller));
272		}
273
274	39	if (1 === strlen($escape) \|\| ('' === $escape && 70400 <= PHP_VERSION_ID)) {
275	33	return [$delimiter, $enclosure, $escape];
276		}
277
278	6	throw new Exception(sprintf('%s() expects escape to be a single character', $caller));
279		}
280
281		/**
282		* Set CSV control.
283		*
284		* @see http://php.net/manual/en/splfileobject.getcsvcontrol.php
285		*
286		* @return string[]
287		*/
288	45	public function getCsvControl()
289		{
290	45	return [$this->delimiter, $this->enclosure, $this->escape];
291		}
292
293		/**
294		* Set CSV stream flags.
295		*
296		* @see http://php.net/manual/en/splfileobject.setflags.php
297		*/
298	33	public function setFlags(int $flags)
299		{
300	33	$this->flags = $flags;
301	33	}
302
303		/**
304		* Write a field array as a CSV line.
305		*
306		* @see http://php.net/manual/en/splfileobject.fputcsv.php
307		*
308		* @return int\|bool
309		*/
310	21	public function fputcsv(array $fields, string $delimiter = ',', string $enclosure = '"', string $escape = '\\')
311		{
312	21	$controls = $this->filterControl($delimiter, $enclosure, $escape, __METHOD__);
313
314	12	return fputcsv($this->stream, $fields, ...$controls);
315		}
316
317		/**
318		* Get line number.
319		*
320		* @see http://php.net/manual/en/splfileobject.key.php
321		*
322		* @return int
323		*/
324	21	public function key()
325		{
326	21	return $this->offset;
327		}
328
329		/**
330		* Read next line.
331		*
332		* @see http://php.net/manual/en/splfileobject.next.php
333		*/
334	18	public function next()
335		{
336	18	$this->value = false;
337	18	$this->offset++;
338	18	}
339
340		/**
341		* Rewind the file to the first line.
342		*
343		* @see http://php.net/manual/en/splfileobject.rewind.php
344		*
345		* @throws Exception if the stream resource is not seekable
346		*/
347	36	public function rewind()
348		{
349	36	if (!$this->is_seekable) {
350	3	throw new Exception('stream does not support seeking');
351		}
352
353	33	rewind($this->stream);
354	33	$this->offset = 0;
355	33	$this->value = false;
356	33	if ($this->flags & SplFileObject::READ_AHEAD) {
357	18	$this->current();
358		}
359	33	}
360
361		/**
362		* Not at EOF.
363		*
364		* @see http://php.net/manual/en/splfileobject.valid.php
365		*
366		* @return bool
367		*/
368	30	public function valid()
369		{
370	30	if ($this->flags & SplFileObject::READ_AHEAD) {
371	18	return $this->current() !== false;
372		}
373
374	12	return !feof($this->stream);
375		}
376
377		/**
378		* Retrieves the current line of the file.
379		*
380		* @see http://php.net/manual/en/splfileobject.current.php
381		*/
382	21	public function current()
383		{
384	21	if (false !== $this->value) {
385	21	return $this->value;
386		}
387
388	21	$this->value = $this->getCurrentRecord();
389
390	21	return $this->value;
391		}
392
393		/**
394		* Retrieves the current line as a CSV Record.
395		*
396		* @return array\|bool
397		*/
398	21	protected function getCurrentRecord()
399		{
400		do {
401	21	$ret = fgetcsv($this->stream, 0, $this->delimiter, $this->enclosure, $this->escape);
402	21	} while ($this->flags & SplFileObject::SKIP_EMPTY && $ret !== false && $ret[0] === null);
403
404	21	return $ret;
405		}
406
407		/**
408		* Seek to specified line.
409		*
410		* @see http://php.net/manual/en/splfileobject.seek.php
411		*
412		* @param int $position
413		* @throws Exception if the position is negative
414		*/
415	12	public function seek($position)
416		{
417	12	if ($position < 0) {
418	3	throw new Exception(sprintf('%s() can\'t seek stream to negative line %d', __METHOD__, $position));
419		}
420
421	9	$this->rewind();
422	6	while ($this->key() !== $position && $this->valid()) {
423	3	$this->current();
424	3	$this->next();
425		}
426
427	6	if (0 !== $position) {
428	3	$this->offset--;
429		}
430
431	6	$this->current();
432	6	}
433
434		/**
435		* Output all remaining data on a file pointer.
436		*
437		* @see http://php.net/manual/en/splfileobject.fpatssthru.php
438		*
439		* @return int
440		*/
441	3	public function fpassthru()
442		{
443	3	return fpassthru($this->stream);
444		}
445
446		/**
447		* Read from file.
448		*
449		* @see http://php.net/manual/en/splfileobject.fread.php
450		*
451		* @param int $length The number of bytes to read
452		*
453		* @return string\|false
454		*/
455	33	public function fread($length)
456		{
457	33	return fread($this->stream, $length);
458		}
459
460		/**
461		* Gets a line from file.
462		*
463		* @see http://php.net/manual/en/splfileobject.fgets.php
464		*
465		* @return string\|false
466		*/
467	6	public function fgets()
468		{
469	6	return fgets($this->stream);
470		}
471
472		/**
473		* Seek to a position.
474		*
475		* @see http://php.net/manual/en/splfileobject.fseek.php
476		*
477		* @throws Exception if the stream resource is not seekable
478		*
479		* @return int
480		*/
481	18	public function fseek(int $offset, int $whence = SEEK_SET)
482		{
483	18	if (!$this->is_seekable) {
484	3	throw new Exception('stream does not support seeking');
485		}
486
487	15	return fseek($this->stream, $offset, $whence);
488		}
489
490		/**
491		* Write to stream.
492		*
493		* @see http://php.net/manual/en/splfileobject.fwrite.php
494		*
495		* @return int\|bool
496		*/
497	3	public function fwrite(string $str, int $length = null)
498		{
499	3	$args = [$this->stream, $str];
500	3	if (null !== $length) {
501	3	$args[] = $length;
502		}
503
504	3	return fwrite(...$args);
505		}
506
507		/**
508		* Flushes the output to a file.
509		*
510		* @see http://php.net/manual/en/splfileobject.fwrite.php
511		*
512		* @return bool
513		*/
514	3	public function fflush()
515		{
516	3	return fflush($this->stream);
517		}
518		}
519

thephpleague / csv

Push — master ( da1a11...3ae0ef )

Stream::setCsvControl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like