Writer::setFlushThreshold() - Code Metrics - Inspection of "Improve Code" - thephpleague/csv - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6ca7fe...652926 )

by ignace nyamagana

created 2017-07-04 08:37 UTC

Writer::setFlushThreshold() A

↳ Parent: Writer

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	9
nc	3
nop	1
dl	0
loc	15
ccs	9
cts	9
cp	1
crap	3
rs	9.4285
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 League\Csv\Exception\InsertionException;
use Traversable;
use TypeError;

/**
 * A class to manage records insertion into a CSV Document
 *
 * @package League.csv
 * @since   4.0.0
 * @author  Ignace Nyamagana Butera <[email protected]>
 *
 */
class Writer extends AbstractCsv
{
    /**
     * callable collection to format the record before insertion
     *
     * @var callable[]
     */
    protected $formatters = [];

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

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

    /**
     * Insert records count for flushing
     *
     * @var int
     */
    protected $flush_counter = 0;

    /**
     * Buffer flush threshold
     *
     * @var int|null
     */
    protected $flush_threshold;

    /**
     * @inheritdoc
     */
    protected $stream_filter_mode = STREAM_FILTER_WRITE;

    /**
     * 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 $records a multidimensional array or a Traversable object
     *
     * @return int
     */
    public function insertAll($records): int
    {
        if (!is_iterable($records)) {
            throw new TypeError(sprintf('%s() expects argument passed to be iterable, %s given', __METHOD__, gettype($records)));
        }

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

        $this->flush_counter = 0;
        $this->document->fflush();

        return $bytes;
    }

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

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

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

    /**
     * Validate a record
     *
     * @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;
        }

        if (null === $this->flush_threshold) {
            return $bytes;
        }

        ++$this->flush_counter;
        if (0 === $this->flush_counter % $this->flush_threshold) {
            $this->flush_counter = 0;
            $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   $validator_name the validator name
     *
     * @return static
     */
    public function addValidator(callable $validator, string $validator_name): self
    {
        $this->validators[$validator_name] = $validator;

        return $this;
    }

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

        return $this;
    }

    /**
     * Set the automatic flush threshold on write
     *
     * @param int|null $threshold
     *
     * @return static
     */
    public function setFlushThreshold($threshold): self
    {
        $this->filterNullableInteger($threshold, 1, __METHOD__.'() expects 1 Argument to be null or a valid integer greater or equal to 1');
        if ($threshold === $this->flush_threshold) {
            return $this;
        }

        $this->flush_threshold = $threshold;
        if (0 < $this->flush_counter) {
            $this->flush_counter = 0;
            $this->document->fflush();
        }

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

thephpleague / csv

Push — master ( 6ca7fe...652926 )

Writer::setFlushThreshold() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like