AbstractCsv::getStreamFilterMode() - Code Metrics - Inspection of "Internal code improved" - thephpleague/csv - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#234)

by ignace nyamagana

created 2017-06-13 07:41 UTC

AbstractCsv::getStreamFilterMode() A

↳ Parent: AbstractCsv

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?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 Generator;
use League\Csv\Exception\LogicException;
use SplFileObject;
use function League\Csv\bom_match;

/**
 *  An abstract class to enable CSV document loading.
 *
 * @package League.csv
 * @since   4.0.0
 * @author  Ignace Nyamagana Butera <[email protected]>
 *
 */
abstract class AbstractCsv implements ByteSequence
{
    use ValidatorTrait;

    /**
     * The CSV document
     *
     * @var StreamIterator|SplFileObject
     */
    protected $document;

    /**
     * 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 = '\\';

    /**
     * The CSV document BOM sequence
     *
     * @var string|null
     */
    protected $input_bom = null;

    /**
     * The Output file BOM character
     *
     * @var string
     */
    protected $output_bom = '';

    /**
     * collection of stream filters
     *
     * @var array
     */
    protected $stream_filters = [];

    /**
     * The stream filter mode (read or write)
     *
     * @var int
     */
    protected $stream_filter_mode;

    /**
     * New instance
     *
     * @param SplFileObject|StreamIterator $document The CSV Object instance
     */
    protected function __construct($document)
    {
        $this->document = $document;
    }

    /**
     * @inheritdoc
     */
    public function __clone()
    {
        throw new LogicException('An object of class '.get_class($this).' cannot be cloned');
    }

    /**
     * Return a new instance from a SplFileObject
     *
     * @param SplFileObject $file
     *
     * @return static
     */
    public static function createFromFileObject(SplFileObject $file): self
    {
        $csv = new static($file);
        $controls = $file->getCsvControl();
        $csv->delimiter = $controls[0];
        $csv->enclosure = $controls[1];
        if (isset($controls[2])) {
            $csv->escape = $controls[2];
        }

        return $csv;
    }

    /**
     * Return a new instance from a PHP resource stream
     *
     * @param resource $stream
     *
     * @return static
     */
    public static function createFromStream($stream): self
    {
        return new static(new StreamIterator($stream));
    }

    /**
     * Return a new instance from a string
     *
     * @param string $content the CSV document as a string
     *
     * @return static
     */
    public static function createFromString(string $content): self
    {
        return new static(StreamIterator::createFromString($content));
    }

    /**
     * Return a new instance from a file path
     *
     * @param string        $path      file path
     * @param string        $open_mode the file open mode flag
     * @param resource|null $context   the resource context
     *
     * @return static
     */
    public static function createFromPath(string $path, string $open_mode = 'r+', $context = null): self
    {
        return new static(StreamIterator::createFromPath($path, $open_mode, $context));
    }

    /**
     * Returns the class filter mode
     *
     * @return int
     */
    public function getStreamFilterMode(): int
    {
        return $this->stream_filter_mode;
    }

    /**
     * Returns the current field delimiter
     *
     * @return string
     */
    public function getDelimiter(): string
    {
        return $this->delimiter;
    }

    /**
     * Returns the current field enclosure
     *
     * @return string
     */
    public function getEnclosure(): string
    {
        return $this->enclosure;
    }

    /**
     * Returns the current field escape character
     *
     * @return string
     */
    public function getEscape(): string
    {
        return $this->escape;
    }

    /**
     * Returns the BOM sequence in use on Output methods
     *
     * @return string
     */
    public function getOutputBOM(): string
    {
        return $this->output_bom;
    }

    /**
     * Returns the BOM sequence of the given CSV
     *
     * @return string
     */
    public function getInputBOM(): string
    {
        if (null === $this->input_bom) {
            $this->document->setFlags(SplFileObject::READ_CSV);
            $this->document->rewind();
            $line = $this->document->fgets();
            $this->input_bom = false === $line ? '' : bom_match($line);
        }

        return $this->input_bom;
    }

    /**
     * Tells whether the stream filter capabilities can be used
     *
     * @return bool
     */
    public function supportsStreamFilter(): bool
    {
        return $this->document instanceof StreamIterator;
    }

    /**
     * Tell whether the specify stream filter is attach to the current stream
     *
     * @param  string $filtername
     * @return bool
     */
    public function hasStreamFilter(string $filtername): bool
    {
        return isset($this->stream_filters[$filtername]);
    }

    /**
     * Retrieves the CSV content
     *
     * @return string
     */
    public function __toString(): string
    {
        $raw = '';
        foreach ($this->chunk(8192) as $chunk) {
            $raw .= $chunk;
        }

        return $raw;
    }

    /**
     * Retuns the CSV document as a Generator of string chunk
     *
     * @param int $length number of bytes read
     *
     * @return Generator
     */
    public function chunk(int $length): Generator
    {
        $length = $this->filterMinRange($length, 1, __METHOD__.'() expects the length to be a positive integer %s given');
        $input_bom = $this->getInputBOM();
        $this->document->rewind();
        if ($input_bom != $this->output_bom) {
            $this->document->fseek(strlen($input_bom));
            $base_chunk = $this->output_bom.$this->document->fread($length);
            $this->document->fflush();
            foreach (str_split($base_chunk, $length) as $chunk) {
                yield $chunk;
            }
        }

        while ($this->document->valid()) {
            $chunk = $this->document->fread($length);
            $this->document->fflush();
            yield $chunk;
        }
    }

    /**
     * Outputs all data on the CSV file
     *
     * @param string $filename CSV downloaded name if present adds extra headers
     *
     * @return int Returns the number of characters read from the handle
     *             and passed through to the output.
     */
    public function output(string $filename = null): int
    {
        if (null !== $filename) {
            header('Content-Type: text/csv');
            header('Content-Transfer-Encoding: binary');
            header('Content-Description: File Transfer');
            header('Content-Disposition: attachment; filename="'.rawurlencode($filename).'"');
        }

        $res = 0;
        $input_bom = $this->getInputBOM();
        $this->document->rewind();
        if ($input_bom != $this->output_bom) {
            $res = strlen($this->output_bom);
            $this->document->fseek(mb_strlen($input_bom));
            echo $this->output_bom;
        }

        return $res + $this->document->fpassthru();
    }

    /**
     * Sets the field delimiter
     *
     * @param string $delimiter
     *
     * @return static
     */
    public function setDelimiter(string $delimiter): self
    {
        $char = $this->filterControl($delimiter, 'delimiter', __METHOD__);
        if ($char != $this->delimiter) {
            $this->delimiter = $char;
            $this->resetProperties();
        }

        return $this;
    }

    /**
     * Reset dynamic object properties to improve performance
     */
    protected function resetProperties()
    {
    }

    /**
     * Sets the field enclosure
     *
     * @param string $enclosure
     *
     * @return static
     */
    public function setEnclosure(string $enclosure): self
    {
        $char = $this->filterControl($enclosure, 'enclosure', __METHOD__);
        if ($char != $this->enclosure) {
            $this->enclosure = $char;
            $this->resetProperties();
        }

        return $this;
    }

    /**
     * Sets the field escape character
     *
     * @param string $escape
     *
     * @return static
     */
    public function setEscape(string $escape): self
    {
        $char = $this->filterControl($escape, 'escape', __METHOD__);
        if ($char != $this->escape) {
            $this->escape = $char;
            $this->resetProperties();
        }


        return $this;
    }

    /**
     * Sets the BOM sequence to prepend the CSV on output
     *
     * @param string $str The BOM sequence
     *
     * @return static
     */
    public function setOutputBOM(string $str): self
    {
        $this->output_bom = $str;

        return $this;
    }

    /**
     * append a stream filter
     *
     * @param string $filtername a string or an object that implements the '__toString' method
     * @param mixed  $params     additional parameters for the filter
     *
     * @throws LogicException If the stream filter API can not be used
     *
     * @return static
     */
    public function addStreamFilter(string $filtername, $params = null): self
    {
        if (!$this->document instanceof StreamIterator) {
            throw new LogicException('The stream filter API can not be used');
        }

        $this->stream_filters[$filtername][] = $this->document->appendFilter($filtername, $this->stream_filter_mode, $params);
        $this->resetProperties();
        $this->input_bom = null;

        return $this;
    }

    /**
     * The destructor
     */
    public function __destruct()
    {
        if ($this->document instanceof StreamIterator) {
            $walker = function ($filter): bool {
                return $this->document->removeFilter($filter);
            };

            array_walk_recursive($this->stream_filters, $walker);
        }

        $this->document = null;
    }
}


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 Generator;
18		use League\Csv\Exception\LogicException;
19		use SplFileObject;
20		use function League\Csv\bom_match;
21
22		/**
23		* An abstract class to enable CSV document loading.
24		*
25		* @package League.csv
26		* @since 4.0.0
27		* @author Ignace Nyamagana Butera <[email protected]>
28		*
29		*/
30		abstract class AbstractCsv implements ByteSequence
31		{
32		use ValidatorTrait;
33
34		/**
35		* The CSV document
36		*
37		* @var StreamIterator\|SplFileObject
38		*/
39		protected $document;
40
41		/**
42		* the field delimiter (one character only)
43		*
44		* @var string
45		*/
46		protected $delimiter = ',';
47
48		/**
49		* the field enclosure character (one character only)
50		*
51		* @var string
52		*/
53		protected $enclosure = '"';
54
55		/**
56		* the field escape character (one character only)
57		*
58		* @var string
59		*/
60		protected $escape = '\\';
61
62		/**
63		* The CSV document BOM sequence
64		*
65		* @var string\|null
66		*/
67		protected $input_bom = null;
68
69		/**
70		* The Output file BOM character
71		*
72		* @var string
73		*/
74		protected $output_bom = '';
75
76		/**
77		* collection of stream filters
78		*
79		* @var array
80		*/
81		protected $stream_filters = [];
82
83		/**
84		* The stream filter mode (read or write)
85		*
86		* @var int
87		*/
88		protected $stream_filter_mode;
89
90		/**
91		* New instance
92		*
93		* @param SplFileObject\|StreamIterator $document The CSV Object instance
94		*/
95	10	protected function __construct($document)
96		{
97	10	$this->document = $document;
98	10	}
99
100		/**
101		* @inheritdoc
102		*/
103	2	public function __clone()
104		{
105	2	throw new LogicException('An object of class '.get_class($this).' cannot be cloned');
106		}
107
108		/**
109		* Return a new instance from a SplFileObject
110		*
111		* @param SplFileObject $file
112		*
113		* @return static
114		*/
115	12	public static function createFromFileObject(SplFileObject $file): self
116		{
117	12	$csv = new static($file);
118	12	$controls = $file->getCsvControl();
119	12	$csv->delimiter = $controls[0];
120	12	$csv->enclosure = $controls[1];
121	12	if (isset($controls[2])) {
122	12	$csv->escape = $controls[2];
123		}
124
125	12	return $csv;
126		}
127
128		/**
129		* Return a new instance from a PHP resource stream
130		*
131		* @param resource $stream
132		*
133		* @return static
134		*/
135	4	public static function createFromStream($stream): self
136		{
137	4	return new static(new StreamIterator($stream));
138		}
139
140		/**
141		* Return a new instance from a string
142		*
143		* @param string $content the CSV document as a string
144		*
145		* @return static
146		*/
147	4	public static function createFromString(string $content): self
148		{
149	4	return new static(StreamIterator::createFromString($content));
150		}
151
152		/**
153		* Return a new instance from a file path
154		*
155		* @param string $path file path
156		* @param string $open_mode the file open mode flag
157		* @param resource\|null $context the resource context
158		*
159		* @return static
160		*/
161	4	public static function createFromPath(string $path, string $open_mode = 'r+', $context = null): self
162		{
163	4	return new static(StreamIterator::createFromPath($path, $open_mode, $context));
164		}
165
166		/**
167		* Returns the class filter mode
168		*
169		* @return int
170		*/
171	2	public function getStreamFilterMode(): int
172		{
173	2	return $this->stream_filter_mode;
174		}
175
176		/**
177		* Returns the current field delimiter
178		*
179		* @return string
180		*/
181	2	public function getDelimiter(): string
182		{
183	2	return $this->delimiter;
184		}
185
186		/**
187		* Returns the current field enclosure
188		*
189		* @return string
190		*/
191	2	public function getEnclosure(): string
192		{
193	2	return $this->enclosure;
194		}
195
196		/**
197		* Returns the current field escape character
198		*
199		* @return string
200		*/
201	2	public function getEscape(): string
202		{
203	2	return $this->escape;
204		}
205
206		/**
207		* Returns the BOM sequence in use on Output methods
208		*
209		* @return string
210		*/
211	2	public function getOutputBOM(): string
212		{
213	2	return $this->output_bom;
214		}
215
216		/**
217		* Returns the BOM sequence of the given CSV
218		*
219		* @return string
220		*/
221	6	public function getInputBOM(): string
222		{
223	6	if (null === $this->input_bom) {
224	6	$this->document->setFlags(SplFileObject::READ_CSV);
225	6	$this->document->rewind();
226	6	$line = $this->document->fgets();
227	6	$this->input_bom = false === $line ? '' : bom_match($line);
228		}
229
230	6	return $this->input_bom;
231		}
232
233		/**
234		* Tells whether the stream filter capabilities can be used
235		*
236		* @return bool
237		*/
238	4	public function supportsStreamFilter(): bool
239		{
240	4	return $this->document instanceof StreamIterator;
241		}
242
243		/**
244		* Tell whether the specify stream filter is attach to the current stream
245		*
246		* @param string $filtername
247		* @return bool
248		*/
249	2	public function hasStreamFilter(string $filtername): bool
250		{
251	2	return isset($this->stream_filters[$filtername]);
252		}
253
254		/**
255		* Retrieves the CSV content
256		*
257		* @return string
258		*/
259	12	public function __toString(): string
260		{
261	12	$raw = '';
262	12	foreach ($this->chunk(8192) as $chunk) {
263	12	$raw .= $chunk;
264		}
265
266	12	return $raw;
267		}
268
269		/**
270		* Retuns the CSV document as a Generator of string chunk
271		*
272		* @param int $length number of bytes read
273		*
274		* @return Generator
275		*/
276	10	public function chunk(int $length): Generator
277		{
278	10	$length = $this->filterMinRange($length, 1, __METHOD__.'() expects the length to be a positive integer %s given');
279	8	$input_bom = $this->getInputBOM();
280	8	$this->document->rewind();
281	8	if ($input_bom != $this->output_bom) {
282	2	$this->document->fseek(strlen($input_bom));
283	2	$base_chunk = $this->output_bom.$this->document->fread($length);
284	2	$this->document->fflush();
285	2	foreach (str_split($base_chunk, $length) as $chunk) {
286	2	yield $chunk;
287		}
288		}
289
290	8	while ($this->document->valid()) {
291	8	$chunk = $this->document->fread($length);
292	8	$this->document->fflush();
293	8	yield $chunk;
294		}
295	8	}
296
297		/**
298		* Outputs all data on the CSV file
299		*
300		* @param string $filename CSV downloaded name if present adds extra headers
301		*
302		* @return int Returns the number of characters read from the handle
303		* and passed through to the output.
304		*/
305	4	public function output(string $filename = null): int
306		{
307	4	if (null !== $filename) {
308	4	header('Content-Type: text/csv');
309	4	header('Content-Transfer-Encoding: binary');
310	4	header('Content-Description: File Transfer');
311	4	header('Content-Disposition: attachment; filename="'.rawurlencode($filename).'"');
312		}
313
314	4	$res = 0;
315	4	$input_bom = $this->getInputBOM();
316	4	$this->document->rewind();
317	4	if ($input_bom != $this->output_bom) {
318	2	$res = strlen($this->output_bom);
319	2	$this->document->fseek(mb_strlen($input_bom));
320	2	echo $this->output_bom;
321		}
322
323	4	return $res + $this->document->fpassthru();
324		}
325
326		/**
327		* Sets the field delimiter
328		*
329		* @param string $delimiter
330		*
331		* @return static
332		*/
333	2	public function setDelimiter(string $delimiter): self
334		{
335	2	$char = $this->filterControl($delimiter, 'delimiter', __METHOD__);
336	2	if ($char != $this->delimiter) {
337	2	$this->delimiter = $char;
338	2	$this->resetProperties();
339		}
340
341	2	return $this;
342		}
343
344		/**
345		* Reset dynamic object properties to improve performance
346		*/
347	2	protected function resetProperties()
348		{
349	2	}
350
351		/**
352		* Sets the field enclosure
353		*
354		* @param string $enclosure
355		*
356		* @return static
357		*/
358	2	public function setEnclosure(string $enclosure): self
359		{
360	2	$char = $this->filterControl($enclosure, 'enclosure', __METHOD__);
361	2	if ($char != $this->enclosure) {
362	2	$this->enclosure = $char;
363	2	$this->resetProperties();
364		}
365
366	2	return $this;
367		}
368
369		/**
370		* Sets the field escape character
371		*
372		* @param string $escape
373		*
374		* @return static
375		*/
376	2	public function setEscape(string $escape): self
377		{
378	2	$char = $this->filterControl($escape, 'escape', __METHOD__);
379	2	if ($char != $this->escape) {
380	2	$this->escape = $char;
381	2	$this->resetProperties();
382		}
383
384
385	2	return $this;
386		}
387
388		/**
389		* Sets the BOM sequence to prepend the CSV on output
390		*
391		* @param string $str The BOM sequence
392		*
393		* @return static
394		*/
395	6	public function setOutputBOM(string $str): self
396		{
397	6	$this->output_bom = $str;
398
399	6	return $this;
400		}
401
402		/**
403		* append a stream filter
404		*
405		* @param string $filtername a string or an object that implements the '__toString' method
406		* @param mixed $params additional parameters for the filter
407		*
408		* @throws LogicException If the stream filter API can not be used
409		*
410		* @return static
411		*/
412	10	public function addStreamFilter(string $filtername, $params = null): self
413		{
414	10	if (!$this->document instanceof StreamIterator) {
415	2	throw new LogicException('The stream filter API can not be used');
416		}
417
418	8	$this->stream_filters[$filtername][] = $this->document->appendFilter($filtername, $this->stream_filter_mode, $params);
419	6	$this->resetProperties();
420	6	$this->input_bom = null;
421
422	6	return $this;
423		}
424
425		/**
426		* The destructor
427		*/
428	14	public function __destruct()
429		{
430	14	if ($this->document instanceof StreamIterator) {
431	4	$walker = function ($filter): bool {
432	4	return $this->document->removeFilter($filter);
433		};
434
435	10	array_walk_recursive($this->stream_filters, $walker);
436		}
437
438	14	$this->document = null;
439	14	}
440		}
441

thephpleague / csv

Pull Request — master (#234)

AbstractCsv::getStreamFilterMode() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like