FileLineIterator::getIterator()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 2
c 1
b 0
f 0
dl 0
loc 4
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 IteratorAggregate;
37
use SplFileObject;
38
use Traversable;
39
40
/**
41
 * @class FileLineIterator
42
 * @package Platine\Etl\Iterator
43
 * @implements IteratorAggregate<int|string, mixed>
44
 */
45
class FileLineIterator implements IteratorAggregate
46
{
47
    /**
48
     * The file to be used
49
     * @var SplFileObject
50
     */
51
    protected SplFileObject $file;
52
53
    /**
54
     * Create new instance
55
     * @param SplFileObject $file
56
     */
57
    public function __construct(SplFileObject $file)
58
    {
59
        $this->file = $file;
60
    }
61
62
    /**
63
     * {@inheritodc}
64
     */
65
    public function getIterator(): Traversable
66
    {
67
        foreach ($this->file as $row) {
68
            yield rtrim($row, PHP_EOL);
0 ignored issues
show
Bug introduced by
It seems like $row can also be of type array; however, parameter $string of rtrim() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

68
            yield rtrim(/** @scrutinizer ignore-type */ $row, PHP_EOL);
Loading history...
69
        }
70
    }
71
72
    /**
73
     * Create file object from filename
74
     * @param string $filename
75
     * @return self
76
     */
77
    public static function createFromFilename(string $filename): self
78
    {
79
        return new self(new SplFileObject($filename));
80
    }
81
}
82