1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
---
layout: default
---
# Overview
[](//twitter.com/nyamsprod)
[](//github.com/thephpleague/csv)
[](//github.com/thephpleague/csv/releases)
[](//github.com/thephpleague/csv/blob/master/LICENSE)
[](https://github.com/thephpleague/csv/actions?query=workflow%3A%22build%22)
[](//packagist.org/packages/league/csv)
**League\Csv** is a simple library to ease CSV document [loading](/9.0/connections/) as well as [writing](/9.0/writer/), [selecting](/9.0/reader/) and [converting](/9.0/converter/) CSV records.
## Usage
### Parsing a CSV document
Access and filter records from a CSV document saved on the local filesystem.
```php
use League\Csv\Reader;
use League\Csv\Statement;
$csv = Reader::createFromPath('/path/to/your/csv/file.csv', 'r');
$csv->setHeaderOffset(0); //set the CSV header offset
$csv->setEscape(''); //required in PHP8.4+ to avoid deprecation notices
//get 25 records starting from the 11th row
$stmt = new Statement()
->offset(10)
->limit(25)
;
$records = $stmt->process($csv);
foreach ($records as $record) {
//do something here
}
```
### Exporting a database table as a CSV document
Fetch data using a `PDOStatement` object, then create a CSV document which is output to the browser.
```php
use League\Csv\Writer;
// We fetch the info from a DB using a PDO object
$sth = $dbh->prepare(
"SELECT firstname, lastname, email FROM users LIMIT 200"
);
// Because we don't want to duplicate the data for each row
// PDO::FETCH_NUM could also have been used
$sth->setFetchMode(PDO::FETCH_ASSOC);
$sth->execute();
// We create the CSV into memory
$csv = Writer::createFromFileObject(new SplTempFileObject());
$csv->setEscape(''); //required in PHP8.4+ to avoid deprecation notices
// We insert the CSV header
$csv->insertOne(['firstname', 'lastname', 'email']);
// The PDOStatement Object implements the Traversable Interface
// that's why Writer::insertAll can directly insert
// the data into the CSV
$csv->insertAll($sth);
// Because you are providing the filename you don't have to
// set the HTTP headers Writer::output can
// directly set them for you
// The file is downloadable
$csv->output('users.csv');
die;
```
### Importing CSV records into a database table
Import records from a CSV document into a database using a `PDOStatement` object
```php
use League\Csv\Reader;
// We are going to insert some data into the users table
$sth = $dbh->prepare(
"INSERT INTO users (firstname, lastname, email) VALUES (:firstname, :lastname, :email)"
);
// By setting the header offset we index all records
// with the header record and remove it from the iteration
$csv = Reader::createFromPath('/path/to/your/csv/file.csv')
->setHeaderOffset(0)
->setEscape('') //required in PHP8.4+ to avoid deprecation notices
;
foreach ($csv as $record) {
// Do not forget to validate your data before inserting it in your database
$sth->bindValue(':firstname', $record['First Name'], PDO::PARAM_STR);
$sth->bindValue(':lastname', $record['Last Name'], PDO::PARAM_STR);
$sth->bindValue(':email', $record['E-mail'], PDO::PARAM_STR);
$sth->execute();
}
```
### Encoding a CSV document into a given charset
It is not possible to detect the character encoding a CSV document (e.g. `UTF-8`, `UTF-16`, etc). However, it *is* possible to detect the input BOM and convert to UTF-8 where necessary.
```php
use League\Csv\Bom;
use League\Csv\Reader;
use League\Csv\CharsetConverter;
$csv = Reader::createFromPath('/path/to/your/csv/file.csv', 'r');
$csv->setHeaderOffset(0);
$csv->setEscape(''); //required in PHP8.4+ to avoid deprecation notices
$inputBom = Bom::tryFrom($csv->getInputBOM());
if ($inputBom instanceof Bom && !$inputBom->isUtf8()) {
CharsetConverter::addTo($csv, $inputBom->encoding(), Bom::Utf8->encoding());
}
foreach ($csv as $record) {
//all fields from the record are converted into UTF-8 charset
}
```
### Converting a CSV document into a XML document
The `XMLConverter` object provided by this package can easily convert a CSV document into a `DOMDocument` object.
```php
use League\Csv\XMLConverter;
use League\Csv\Reader;
$csv = Reader::createFromPath('/path/to/prenoms.csv', 'r')
$csv->setDelimiter(';');
$csv->setHeaderOffset(0);
$csv->setEscape(''); //required in PHP8.4+ to avoid deprecation notices
$converter = new XMLConverter()
->rootElement('csv')
->recordElement('record', 'offset')
->fieldElement('field', 'name')
;
$dom = $converter->convert($records);
$dom->formatOutput = true;
$dom->encoding = 'iso-8859-15';
echo '<pre>', PHP_EOL;
echo htmlentities($dom->saveXML());
// <?xml version="1.0" encoding="iso-8859-15"?>
// <csv>
// <record offset="0">
// <field name="prenoms">Anaïs</field>
// <field name="nombre">137</field>
// <field name="sexe">F</field>
// <field name="annee">2004</field>
// </record>
// ...
// <record offset="1099">
// <field name="prenoms">Anaïs</field>
// <field name="nombre">124</field>
// <field name="sexe">F</field>
// <field name="annee">2005</field>
// </record>
// </csv>
```
|
