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 Countable; |
37
|
|
|
use FilterIterator; |
38
|
|
|
use SplFileObject; |
39
|
|
|
|
40
|
|
|
/** |
41
|
|
|
* @class CsvFileIterator |
42
|
|
|
* @package Platine\Etl\Iterator |
43
|
|
|
*/ |
44
|
|
|
class CsvFileIterator extends FilterIterator implements Countable, CsvIteratorInterface |
45
|
|
|
{ |
46
|
|
|
/** |
47
|
|
|
* The file to be used |
48
|
|
|
* @var SplFileObject |
49
|
|
|
*/ |
50
|
|
|
protected SplFileObject $file; |
51
|
|
|
|
52
|
|
|
/** |
53
|
|
|
* The total record in CSV |
54
|
|
|
* @var int |
55
|
|
|
*/ |
56
|
|
|
protected int $totalLine = 0; |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* Create new instance |
60
|
|
|
* @param SplFileObject $file |
61
|
|
|
* @param string $delimiter |
62
|
|
|
* @param string $enclosure |
63
|
|
|
* @param string $escapeString |
64
|
|
|
*/ |
65
|
|
|
public function __construct( |
66
|
|
|
SplFileObject $file, |
67
|
|
|
string $delimiter = ',', |
68
|
|
|
string $enclosure = '"', |
69
|
|
|
string $escapeString = '\\' |
70
|
|
|
) { |
71
|
|
|
$this->file = $file; |
72
|
|
|
$this->file->setCsvControl($delimiter, $enclosure, $escapeString); |
73
|
|
|
$this->file->setFlags(SplFileObject::READ_CSV); |
74
|
|
|
|
75
|
|
|
parent::__construct($this->file); |
76
|
|
|
} |
77
|
|
|
|
78
|
|
|
|
79
|
|
|
/** |
80
|
|
|
* Create file object from filename |
81
|
|
|
* @param string $filename |
82
|
|
|
* @param string $delimiter |
83
|
|
|
* @param string $enclosure |
84
|
|
|
* @param string $escapeString |
85
|
|
|
* @return self |
86
|
|
|
*/ |
87
|
|
|
public static function createFromFilename( |
88
|
|
|
string $filename, |
89
|
|
|
string $delimiter = ',', |
90
|
|
|
string $enclosure = '"', |
91
|
|
|
string $escapeString = '\\' |
92
|
|
|
): self { |
93
|
|
|
return new static( |
94
|
|
|
new SplFileObject($filename, 'r'), |
95
|
|
|
$delimiter, |
96
|
|
|
$enclosure, |
97
|
|
|
$escapeString |
98
|
|
|
); |
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
/** |
102
|
|
|
* {@inheritodc} |
103
|
|
|
*/ |
104
|
|
|
public function accept(): bool |
105
|
|
|
{ |
106
|
|
|
$current = $this->getInnerIterator()->current(); |
107
|
|
|
if (!is_array($current)) { |
108
|
|
|
return false; |
109
|
|
|
} |
110
|
|
|
|
111
|
|
|
return count( |
112
|
|
|
array_filter( |
113
|
|
|
$current, |
114
|
|
|
function ($cell) { |
115
|
|
|
return $cell !== null; |
116
|
|
|
} |
117
|
|
|
) |
118
|
|
|
) > 0; |
119
|
|
|
} |
120
|
|
|
|
121
|
|
|
|
122
|
|
|
/** |
123
|
|
|
* {@inheritodc} |
124
|
|
|
*/ |
125
|
|
|
public function count(): int |
126
|
|
|
{ |
127
|
|
|
if ($this->totalLine === 0) { |
128
|
|
|
$this->rewind(); |
129
|
|
|
|
130
|
|
|
$this->totalLine = count(iterator_to_array($this)); |
131
|
|
|
} |
132
|
|
|
|
133
|
|
|
return $this->totalLine; |
134
|
|
|
} |
135
|
|
|
} |
136
|
|
|
|