|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Palmtree\Csv; |
|
4
|
|
|
|
|
5
|
|
|
abstract class AbstractCsv |
|
6
|
|
|
{ |
|
7
|
|
|
/** @var string */ |
|
8
|
|
|
protected $openMode; |
|
9
|
|
|
/** @var string */ |
|
10
|
|
|
protected $file; |
|
11
|
|
|
/** @var bool */ |
|
12
|
|
|
protected $hasHeaders; |
|
13
|
|
|
/** @var string */ |
|
14
|
|
|
protected $delimiter; |
|
15
|
|
|
/** @var string */ |
|
16
|
|
|
protected $enclosure; |
|
17
|
|
|
/** @var string */ |
|
18
|
|
|
protected $escapeCharacter; |
|
19
|
|
|
/** @var CsvFileObject */ |
|
20
|
|
|
protected $document; |
|
21
|
|
|
|
|
22
|
|
|
/** |
|
23
|
|
|
* AbstractCsv constructor. |
|
24
|
|
|
* |
|
25
|
|
|
* @param string $file Path to CSV file. |
|
26
|
|
|
* @param bool $hasHeaders Whether the CSV file contains headers. |
|
27
|
|
|
* @param string $delimiter Cell delimiter. Default ',' (comma). |
|
28
|
5 |
|
* @param string $enclosure Cell enclosure. Default '"' (double quote) |
|
29
|
|
|
* @param string $escape Cell escape character. Default null byte. |
|
30
|
5 |
|
*/ |
|
31
|
5 |
|
public function __construct($file, $hasHeaders = true, $delimiter = ',', $enclosure = '"', $escape = "\0") |
|
32
|
5 |
|
{ |
|
33
|
5 |
|
$this->setFile($file) |
|
34
|
5 |
|
->setHasHeaders($hasHeaders) |
|
35
|
|
|
->setDelimiter($delimiter) |
|
36
|
|
|
->setEnclosure($enclosure) |
|
37
|
|
|
->setEscapeCharacter($escape); |
|
38
|
|
|
} |
|
39
|
5 |
|
|
|
40
|
|
|
/** |
|
41
|
5 |
|
* AbstractCsv destructor. |
|
42
|
5 |
|
*/ |
|
43
|
|
|
public function __destruct() |
|
44
|
|
|
{ |
|
45
|
|
|
$this->closeDocument(); |
|
46
|
|
|
} |
|
47
|
2 |
|
|
|
48
|
|
|
/** |
|
49
|
2 |
|
* Creates a new SplFileObject instance. |
|
50
|
|
|
*/ |
|
51
|
2 |
|
public function createDocument() |
|
52
|
|
|
{ |
|
53
|
|
|
$this->closeDocument(); |
|
54
|
|
|
|
|
55
|
|
|
$document = new CsvFileObject($this->getFile(), $this->getOpenMode()); |
|
56
|
|
|
|
|
57
|
|
|
$document->setFlags( |
|
58
|
|
|
CsvFileObject::READ_CSV | |
|
59
|
|
|
CsvFileObject::READ_AHEAD | |
|
60
|
|
|
CsvFileObject::SKIP_EMPTY | |
|
61
|
|
|
CsvFileObject::DROP_NEW_LINE |
|
62
|
|
|
); |
|
63
|
|
|
|
|
64
|
|
|
$document->setCsvControl($this->getDelimiter(), $this->getEnclosure(), $this->getEscapeCharacter()); |
|
65
|
|
|
|
|
66
|
|
|
$this->setDocument($document); |
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
5 |
|
/** |
|
70
|
|
|
* Closes the document by setting our reference to null |
|
71
|
5 |
|
* to ensure its destructor is called. |
|
72
|
5 |
|
*/ |
|
73
|
|
|
public function closeDocument() |
|
74
|
|
|
{ |
|
75
|
|
|
$this->document = null; |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
/** |
|
79
|
|
|
* @param CsvFileObject|null $document |
|
80
|
|
|
* |
|
81
|
|
|
* @return AbstractCsv |
|
82
|
|
|
*/ |
|
83
|
|
|
public function setDocument($document) |
|
84
|
|
|
{ |
|
85
|
|
|
$this->closeDocument(); |
|
86
|
|
|
|
|
87
|
|
|
$this->document = $document; |
|
88
|
|
|
|
|
89
|
|
|
return $this; |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
|
|
/** |
|
93
|
|
|
* @return CsvFileObject |
|
94
|
|
|
*/ |
|
95
|
|
|
public function getDocument() |
|
96
|
|
|
{ |
|
97
|
|
|
if (!$this->document) { |
|
98
|
|
|
$this->createDocument(); |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
return $this->document; |
|
102
|
|
|
} |
|
103
|
2 |
|
|
|
104
|
|
|
/** |
|
105
|
2 |
|
* @return string |
|
106
|
|
|
*/ |
|
107
|
|
|
public function getFile() |
|
108
|
|
|
{ |
|
109
|
|
|
return $this->file; |
|
110
|
|
|
} |
|
111
|
|
|
|
|
112
|
|
|
/** |
|
113
|
5 |
|
* @param string $file |
|
114
|
|
|
* |
|
115
|
5 |
|
* @return $this |
|
116
|
|
|
*/ |
|
117
|
5 |
|
public function setFile($file) |
|
118
|
|
|
{ |
|
119
|
|
|
$this->file = $file; |
|
120
|
|
|
|
|
121
|
|
|
return $this; |
|
122
|
|
|
} |
|
123
|
|
|
|
|
124
|
|
|
/** |
|
125
|
|
|
* @return bool |
|
126
|
|
|
*/ |
|
127
|
|
|
public function hasHeaders() |
|
128
|
|
|
{ |
|
129
|
|
|
return $this->hasHeaders; |
|
130
|
|
|
} |
|
131
|
|
|
|
|
132
|
|
|
/** |
|
133
|
5 |
|
* @param bool $hasHeaders |
|
134
|
|
|
* |
|
135
|
5 |
|
* @return AbstractCsv |
|
136
|
|
|
*/ |
|
137
|
5 |
|
public function setHasHeaders($hasHeaders) |
|
138
|
|
|
{ |
|
139
|
|
|
$this->hasHeaders = (bool)$hasHeaders; |
|
140
|
|
|
|
|
141
|
|
|
return $this; |
|
142
|
|
|
} |
|
143
|
|
|
|
|
144
|
|
|
/** |
|
145
|
|
|
* @return string |
|
146
|
|
|
*/ |
|
147
|
|
|
public function getDelimiter() |
|
148
|
|
|
{ |
|
149
|
|
|
return $this->delimiter; |
|
150
|
|
|
} |
|
151
|
|
|
|
|
152
|
|
|
/** |
|
153
|
5 |
|
* @param string $delimiter |
|
154
|
|
|
* |
|
155
|
5 |
|
* @return AbstractCsv |
|
156
|
|
|
*/ |
|
157
|
5 |
|
public function setDelimiter($delimiter) |
|
158
|
|
|
{ |
|
159
|
|
|
$this->delimiter = $delimiter; |
|
160
|
|
|
|
|
161
|
|
|
return $this; |
|
162
|
|
|
} |
|
163
|
|
|
|
|
164
|
|
|
/** |
|
165
|
|
|
* @return string |
|
166
|
|
|
*/ |
|
167
|
|
|
public function getEnclosure() |
|
168
|
|
|
{ |
|
169
|
|
|
return $this->enclosure; |
|
170
|
|
|
} |
|
171
|
|
|
|
|
172
|
|
|
/** |
|
173
|
5 |
|
* @param string $enclosure |
|
174
|
|
|
* |
|
175
|
5 |
|
* @return AbstractCsv |
|
176
|
|
|
*/ |
|
177
|
5 |
|
public function setEnclosure($enclosure) |
|
178
|
|
|
{ |
|
179
|
|
|
$this->enclosure = $enclosure; |
|
180
|
|
|
|
|
181
|
|
|
return $this; |
|
182
|
|
|
} |
|
183
|
2 |
|
|
|
184
|
|
|
/** |
|
185
|
2 |
|
* @return string |
|
186
|
|
|
*/ |
|
187
|
|
|
public function getOpenMode() |
|
188
|
|
|
{ |
|
189
|
|
|
return $this->openMode; |
|
190
|
|
|
} |
|
191
|
|
|
|
|
192
|
|
|
/** |
|
193
|
|
|
* @return string |
|
194
|
|
|
*/ |
|
195
|
|
|
public function getEscapeCharacter() |
|
196
|
|
|
{ |
|
197
|
|
|
return $this->escapeCharacter; |
|
198
|
|
|
} |
|
199
|
|
|
|
|
200
|
|
|
/** |
|
201
|
|
|
* @param string $escapeCharacter |
|
202
|
|
|
* |
|
203
|
|
|
* @return AbstractCsv |
|
204
|
|
|
*/ |
|
205
|
|
|
public function setEscapeCharacter($escapeCharacter) |
|
206
|
|
|
{ |
|
207
|
|
|
$this->escapeCharacter = $escapeCharacter; |
|
208
|
|
|
|
|
209
|
|
|
return $this; |
|
210
|
|
|
} |
|
211
|
|
|
} |
|
212
|
|
|
|
palmtreephp /
csv
