Writer::initCsv() - 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-22 09:47 UTC

Writer::initCsv() A

↳ Parent: Writer

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?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 Traversable;

/**
 * A class to manage data insertion into a CSV
 *
 * @package League.csv
 * @since   4.0.0
 * @author  Ignace Nyamagana Butera <[email protected]>
 *
 */
class Writer extends AbstractCsv
{
    /**
     * @inheritdoc
     */
    protected $stream_filter_mode = STREAM_FILTER_WRITE;

    /**
     * callable collection to validate the record before insertion
     *
     * @var callable[]
     */
    protected $validators = [];

    /**
     * callable collection to format the record before insertion
     *
     * @var callable[]
     */
    protected $formatters = [];

    /**
     * Insert Rows count
     *
     * @var int
     */
    protected $insert_count = 0;

    /**
     * newline character
     *
     * @var string
     */
    protected $newline = "\n";

    /**
     * Buffer flush threshold
     *
     * @var int
     */
    protected $flush_threshold = 500;

    /**
     * Returns the current newline sequence characters
     *
     * @return string
     */
    public function getNewline(): string
    {
        return $this->newline;
    }

    /**
     * Get the flush threshold
     *
     * @return int|null
     */
    public function getFlushThreshold()
    {
        return $this->flush_threshold;
    }

    /**
     * Adds multiple lines to the CSV document
     *
     * a simple wrapper method around insertOne
     *
     * @param Traversable|array $rows a multidimensional array or a Traversable object
     *
     * @throws InvalidArgumentException If the given rows format is invalid
     *
     * @return int
     */
    public function insertAll($rows): int
    {
        if (!is_array($rows) && !$rows instanceof Traversable) {
            throw new InvalidArgumentException('the provided data must be an array OR a `Traversable` object');
        }

        $bytes = 0;
        foreach ($rows as $row) {
            $bytes += $this->insertOne($row);
        }

        return $bytes;
    }

    /**
     * Adds a single line to a CSV document
     *
     * @param string[] $row an array
     *
     * @throws InsertionException If the row can not be inserted
     *
     * @return int
     */
    public function insertOne(array $row): int
    {
        $record = array_reduce($this->formatters, [$this, 'formatRecord'], $row);
        $this->validateRecord($record);
        $bytes = $this->document->fputcsv($record, $this->delimiter, $this->enclosure, $this->escape);
        if (!$bytes) {
            throw InsertionException::createFromCsv($record);
        }

        return $bytes + $this->consolidate();
    }

    /**
     * Format the given row
     *
     * @param string[] $record
     * @param callable $formatter
     *
     * @return string[]
     */
    protected function formatRecord(array $record, callable $formatter): array
    {
        return $formatter($record);
    }

    /**
     * Validate a row
     *
     * @param string[] $record
     *
     * @throws InsertionException If the validation failed
     */
    protected function validateRecord(array $record)
    {
        foreach ($this->validators as $name => $validator) {
            if (true !== ($validator)($record)) {
                throw InsertionException::createFromValidator($name, $record);
            }
        }
    }

    /**
     * Apply post insertion actions
     *
     * @return int
     */
    protected function consolidate(): int
    {
        $bytes = 0;
        if ("\n" !== $this->newline) {
            $this->document->fseek(-1, SEEK_CUR);
            $bytes = $this->document->fwrite($this->newline, strlen($this->newline)) - 1;
        }

        $this->insert_count++;
        if (null !== $this->flush_threshold && 0 === $this->insert_count % $this->flush_threshold) {
            $this->document->fflush();
        }

        return $bytes;
    }

    /**
     * add a formatter to the collection
     *
     * @param callable $formatter
     *
     * @return static
     */
    public function addFormatter(callable $formatter): self
    {
        $this->formatters[] = $formatter;

        return $this;
    }

    /**
     * add a Validator to the collection
     *
     * @param callable $validator
     * @param string   $name      the validator name
     *
     * @return static
     */
    public function addValidator(callable $validator, string $name): self
    {
        $this->validators[$name] = $validator;

        return $this;
    }

    /**
     * Sets the newline sequence characters
     *
     * @param string $newline
     *
     * @return static
     */
    public function setNewline(string $newline): self
    {
        $this->newline = (string) $newline;

        return $this;
    }

    /**
     * Set the automatic flush threshold on write
     *
     * @param int|null $val
     */
    public function setFlushThreshold($val): self
    {
        if (null !== $val) {
            $val = $this->filterInteger($val, 1, 'The flush threshold must be a valid positive integer or null');
        }

        $this->flush_threshold = $val;

        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 Traversable;
18
19		/**
20		* A class to manage data insertion into a CSV
21		*
22		* @package League.csv
23		* @since 4.0.0
24		* @author Ignace Nyamagana Butera <[email protected]>
25		*
26		*/
27		class Writer extends AbstractCsv
28		{
29		/**
30		* @inheritdoc
31		*/
32		protected $stream_filter_mode = STREAM_FILTER_WRITE;
33
34		/**
35		* callable collection to validate the record before insertion
36		*
37		* @var callable[]
38		*/
39		protected $validators = [];
40
41		/**
42		* callable collection to format the record before insertion
43		*
44		* @var callable[]
45		*/
46		protected $formatters = [];
47
48		/**
49		* Insert Rows count
50		*
51		* @var int
52		*/
53		protected $insert_count = 0;
54
55		/**
56		* newline character
57		*
58		* @var string
59		*/
60		protected $newline = "\n";
61
62		/**
63		* Buffer flush threshold
64		*
65		* @var int
66		*/
67		protected $flush_threshold = 500;
68
69		/**
70		* Returns the current newline sequence characters
71		*
72		* @return string
73		*/
74	4	public function getNewline(): string
75		{
76	4	return $this->newline;
77		}
78
79		/**
80		* Get the flush threshold
81		*
82		* @return int\|null
83		*/
84	2	public function getFlushThreshold()
85		{
86	2	return $this->flush_threshold;
87		}
88
89		/**
90		* Adds multiple lines to the CSV document
91		*
92		* a simple wrapper method around insertOne
93		*
94		* @param Traversable\|array $rows a multidimensional array or a Traversable object
95		*
96		* @throws InvalidArgumentException If the given rows format is invalid
97		*
98		* @return int
99		*/
100	6	public function insertAll($rows): int
101		{
102	6	if (!is_array($rows) && !$rows instanceof Traversable) {
103	2	throw new InvalidArgumentException('the provided data must be an array OR a `Traversable` object');
104		}
105
106	4	$bytes = 0;
107	4	foreach ($rows as $row) {
108	4	$bytes += $this->insertOne($row);
109		}
110
111	4	return $bytes;
112		}
113
114		/**
115		* Adds a single line to a CSV document
116		*
117		* @param string[] $row an array
118		*
119		* @throws InsertionException If the row can not be inserted
120		*
121		* @return int
122		*/
123	32	public function insertOne(array $row): int
124		{
125	32	$record = array_reduce($this->formatters, [$this, 'formatRecord'], $row);
126	32	$this->validateRecord($record);
127	28	$bytes = $this->document->fputcsv($record, $this->delimiter, $this->enclosure, $this->escape);
128	28	if (!$bytes) {
129	2	throw InsertionException::createFromCsv($record);
130		}
131
132	26	return $bytes + $this->consolidate();
133		}
134
135		/**
136		* Format the given row
137		*
138		* @param string[] $record
139		* @param callable $formatter
140		*
141		* @return string[]
142		*/
143	4	protected function formatRecord(array $record, callable $formatter): array
144		{
145	4	return $formatter($record);
146		}
147
148		/**
149		* Validate a row
150		*
151		* @param string[] $record
152		*
153		* @throws InsertionException If the validation failed
154		*/
155	32	protected function validateRecord(array $record)
156		{
157	32	foreach ($this->validators as $name => $validator) {
158	8	if (true !== ($validator)($record)) {
159	8	throw InsertionException::createFromValidator($name, $record);
160		}
161		}
162	28	}
163
164		/**
165		* Apply post insertion actions
166		*
167		* @return int
168		*/
169	26	protected function consolidate(): int
170		{
171	26	$bytes = 0;
172	26	if ("\n" !== $this->newline) {
173	4	$this->document->fseek(-1, SEEK_CUR);
174	4	$bytes = $this->document->fwrite($this->newline, strlen($this->newline)) - 1;
175		}
176
177	26	$this->insert_count++;
178	26	if (null !== $this->flush_threshold && 0 === $this->insert_count % $this->flush_threshold) {
179	2	$this->document->fflush();
180		}
181
182	26	return $bytes;
183		}
184
185		/**
186		* add a formatter to the collection
187		*
188		* @param callable $formatter
189		*
190		* @return static
191		*/
192	4	public function addFormatter(callable $formatter): self
193		{
194	4	$this->formatters[] = $formatter;
195
196	4	return $this;
197		}
198
199		/**
200		* add a Validator to the collection
201		*
202		* @param callable $validator
203		* @param string $name the validator name
204		*
205		* @return static
206		*/
207	8	public function addValidator(callable $validator, string $name): self
208		{
209	8	$this->validators[$name] = $validator;
210
211	8	return $this;
212		}
213
214		/**
215		* Sets the newline sequence characters
216		*
217		* @param string $newline
218		*
219		* @return static
220		*/
221	4	public function setNewline(string $newline): self
222		{
223	4	$this->newline = (string) $newline;
224
225	4	return $this;
226		}
227
228		/**
229		* Set the automatic flush threshold on write
230		*
231		* @param int\|null $val
232		*/
233	4	public function setFlushThreshold($val): self
234		{
235	4	if (null !== $val) {
236	4	$val = $this->filterInteger($val, 1, 'The flush threshold must be a valid positive integer or null');
237		}
238
239	4	$this->flush_threshold = $val;
240
241	4	return $this;
242		}
243		}
244

thephpleague / csv

Pull Request — master (#210)

Writer::initCsv() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like