TextLineIterator::strtokIterator()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 7
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 5
c 1
b 0
f 0
dl 0
loc 7
rs 10
cc 2
nc 2
nop 0
1
<?php
2
3
/**
4
 * Platine ETL
5
 *
6
 * Platine ETL is a library to Extract-Transform-Load Data from various sources
7
 *
8
 * This content is released under the MIT License (MIT)
9
 *
10
 * Copyright (c) 2020 Platine ETL
11
 * Copyright (c) 2019 Benoit POLASZEK
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
declare(strict_types=1);
33
34
namespace Platine\Etl\Iterator;
35
36
use Generator;
37
use IteratorAggregate;
38
use Traversable;
39
40
/**
41
 * @class TextLineIterator
42
 * @package Platine\Etl\Iterator
43
 * @implements IteratorAggregate<int|string, mixed>
44
 */
45
class TextLineIterator implements StringIteratorInterface, IteratorAggregate
46
{
47
    /**
48
     * The content
49
     * @var string
50
     */
51
    protected string $content;
52
53
    /**
54
     * Whether to skip empty line
55
     * @var bool
56
     */
57
    protected bool $skipEmptyLine = true;
58
59
    /**
60
     * Create new instance
61
     * @param string $content
62
     * @param bool $skipEmptyLine
63
     */
64
    public function __construct(string $content, bool $skipEmptyLine = true)
65
    {
66
        $this->content = $content;
67
        $this->skipEmptyLine = $skipEmptyLine;
68
    }
69
70
71
    /**
72
     * {@inheritodc}
73
     */
74
    public function getIterator(): Traversable
75
    {
76
        if ($this->skipEmptyLine) {
77
            return $this->strtokIterator();
78
        }
79
80
        return $this->pregSplitIterator();
81
    }
82
83
    /**
84
     * Uses a regex to split lines.
85
     * @return Traversable<int|string, mixed>
86
     */
87
    protected function pregSplitIterator(): Traversable
88
    {
89
        $lines = (array) preg_split("/((\r?\n)|(\r\n?))/", $this->content);
90
        foreach ($lines as $line) {
91
            yield $line;
92
        }
93
    }
94
95
    /**
96
     * Uses "strtok" to split lines. Provides better performance, but skips empty lines.
97
     * @return Traversable<int|string, mixed>
98
     */
99
    protected function strtokIterator(): Traversable
100
    {
101
        $tok = strtok($this->content, "\r\n");
102
        while ($tok !== false) {
103
            $line = $tok;
104
            $tok = strtok("\n\r");
105
            yield $line;
106
        }
107
    }
108
}
109