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
|
---
layout: default
title: Upgrading from 5.x to 6.x
---
# Upgrading from 5.x to 6.x
## Installation
If you are using composer then you should update the require section of your `composer.json` file.
```bash
composer require league/csv:~6.0
```
This will edit (or create) your `composer.json` file.
## New Features
### Stream Filter API
The Stream Filter API is introduced. Please [refer to the documentation](/filtering/) for more information
## Added Methods
### Named Constructors
The new preferred way to instantiate a CSV object is to use the [named constructors](/overview/#instantiation):
Two new named constructors are added to complement the already present `createFromString` method.
- `createFromPath`;
- `createFromFileObject`;
You can still use the class constructor for backward compatibility.
## Backward Incompatible Changes
### Detecting CSV Delimiters
The `detectDelimiter` method is removed and replaced by the `detectDelimiterList` method.
The difference between both methods is that the latter always return an `array` as the former was throwing `RuntimeException` when multiple delimiters where found (*ie.*: the CSV was inconsistent)
Old code:
```php
use League\Csv\Reader;
$reader = new Reader('/path/to/your/csv/file.csv');
try {
$delimiter = $reader->detectDelimiter(10, [' ', '|']);
if (is_null($delimiter)) {
//no delimiter found
}
} catch(RuntimeException $e) {
//inconsistent CSV the found delimiters were given in $e->getMessage();
}
```
New code:
```php
use League\Csv\Reader;
$reader = Reader::createFromPath('/path/to/your/csv/file.csv', 'r');
$delimiters_list = $reader->detectDelimiterList(10, [' ', '|']);
if (! $delimiters_list) {
//no delimiter found
} elseif (1 == count($delimiters_list)) {
$delimiter = array_shift($delimiters); // the found delimiter
} else {
//inconsistent CSV
var_dump($delimiters_list); // all the delimiters found
}
```
### Transcoding Charset Property
`setEncoding`/`getEncoding`: the `$encodingFrom` property setter and getter are renamed `setEncodingFrom`/`getEncodingFrom` to avoid any ambiguity.
**The library always assumes that the output is in `UTF-8`** so when transcoding your CSV you should always transcode from the `$encodingFrom` charset into an UTF-8 compatible charset.
You need to upgrade your code accordingly.
Old code:
```php
use League\Csv\Reader;
$reader = new Reader('/path/to/your/csv/file.csv');
$reader->setEncoding('SJIS');
$charset = $reader->getEncoding(); //returns 'SJIS'
$reader->output();
```
New code:
```php
use League\Csv\Reader;
$reader = new Reader('/path/to/your/csv/file.csv');
$reader->setEncodingFrom('SJIS');
$charset = $reader->getEncodingFrom(); //returns 'SJIS'
$reader->output();
```
### Creating New Instances From Existing CSV Objects
`League\Csv\Writer::getReader` and `League\Csv\Reader::getWriter` are removed.
The new methods `newWriter` and `newReader` are available on **both** classes. This means you can create a CSV reader and/or a CSV writer object from any given object.
- `newWriter` behaves exactly like `getWriter`;
- `newReader` behaves exactly like `getReader`;
Old code:
```php
use League\Csv\Reader;
$reader = new Reader('/path/to/your/csv/file.csv');
$writer = $reader->getWriter('a+');
$another_reader = $writer->getReader();
```
New code:
```php
use League\Csv\Reader;
$reader = Reader::createFromPath('/path/to/your/csv/file.csv', 'r');
$writer = $reader->newWriter('a+');
$another_writer = $writer->newWriter('rb+');
$another_reader1 = $writer->newReader();
$another_reader2 = $reader->newReader();
```
## Already deprecated methods in 5.0 series, removed in 6.0
- `setSortBy`: deprecated since version 5.2 and replaced by `addSortBy`.
- `setFilter`: deprecated since version 5.1 and replaced by `addFilter`.
|
