Skip to content

Commit 62c1903

Browse files
committed
Update documentation with new static methods usage
1 parent 9598913 commit 62c1903

25 files changed

+146
-146
lines changed

docs/9.0/connections/bom.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ The CSV document current BOM character is detected using the `getInputBOM` metho
112112
```php
113113
use League\Csv\Reader;
114114

115-
$csv = Reader::createFromPath('/path/to/file.csv');
115+
$csv = Reader::from('/path/to/file.csv');
116116
$bom = $csv->getInputBOM();
117117
```
118118

@@ -133,7 +133,7 @@ public AbstractCsv::getOutputBOM(void): string
133133
use League\Csv\Bom;
134134
use League\Csv\Reader;
135135

136-
$csv = Reader::createFromPath('/path/to/file.csv', 'r');
136+
$csv = Reader::from('/path/to/file.csv', 'r');
137137
$csv->setOutputBOM(Bom::Utf8);
138138
$bom = $csv->getOutputBOM(); //returns "\xEF\xBB\xBF"
139139
```
@@ -163,7 +163,7 @@ If your document does not contain any BOM sequence you can speed up the CSV iter
163163

164164
```php
165165
$raw_csv = Bom::Utf8->value."john,doe,john.doe@example.com\njane,doe,jane.doe@example.com\n";
166-
$csv = Reader::createFromString($raw_csv);
166+
$csv = Reader::fromString($raw_csv);
167167
$csv->setOutputBOM(Bom::Utf16Le);
168168
$csv->includeInputBOM();
169169
ob_start();

docs/9.0/connections/controls.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public AbstractCsv::getDelimiter(void): string
2121
```php
2222
use League\Csv\Reader;
2323

24-
$csv = Reader::createFromPath('/path/to/file.csv', 'r');
24+
$csv = Reader::from('/path/to/file.csv', 'r');
2525
$csv->setDelimiter(';');
2626
$delimiter = $csv->getDelimiter(); //returns ";"
2727
```
@@ -44,7 +44,7 @@ public AbstractCsv::getEnclosure(void): string
4444
```php
4545
use League\Csv\Writer;
4646

47-
$csv = Writer::createFromPath('/path/to/file.csv');
47+
$csv = Writer::from('/path/to/file.csv');
4848
$csv->setEnclosure('|');
4949
$enclosure = $csv->getEnclosure(); //returns "|"
5050
```
@@ -75,7 +75,7 @@ public AbstractCsv::getEscape(void): string
7575
```php
7676
use League\Csv\Reader;
7777

78-
$csv = Reader::createFromPath('/path/to/file.csv', 'r');
78+
$csv = Reader::from('/path/to/file.csv', 'r');
7979
$csv->setEscape('\\');
8080
$escape = $csv->getEscape(); //returns "\"
8181
```
@@ -87,7 +87,7 @@ $escape = $csv->getEscape(); //returns "\"
8787
```php
8888
use League\Csv\Reader;
8989

90-
$csv = Reader::createFromPath('/path/to/file.csv', 'r');
90+
$csv = Reader::from('/path/to/file.csv', 'r');
9191
$csv->setEscape('');
9292
$escape = $csv->getEscape(); //returns ""
9393
```
@@ -101,7 +101,7 @@ $file = new SplTempFileObject();
101101
$file->setFlags(SplFileObject::READ_CSV);
102102
$file->setCsvControl('|', "'", "\\");
103103

104-
$csv = Reader::createFromFileObject($file);
104+
$csv = Reader::from($file);
105105

106106
echo $csv->getDelimiter(); //display '|'
107107
echo $csv->getEnclosure(); //display "'"
@@ -136,7 +136,7 @@ and returns an associated array whose keys are the submitted delimiters characte
136136
use League\Csv\Info;
137137
use League\Csv\Reader;
138138

139-
$reader = Reader::createFromPath('/path/to/file.csv', 'r');
139+
$reader = Reader::from('/path/to/file.csv', 'r');
140140
$reader->setEnclosure('"');
141141
$reader->setEscape('\\');
142142

docs/9.0/connections/filters.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ public AbstractCsv::supportsStreamFilterOnWrite(void): bool
2525
use League\Csv\Reader;
2626
use League\Csv\Writer;
2727

28-
$reader = Reader::createFromPath('/path/to/my/file.csv', 'r');
28+
$reader = Reader::from('/path/to/my/file.csv', 'r');
2929
$reader->supportsStreamFilterOnRead(); //returns true
3030
$reader->supportsStreamFilterOnWrite(); //returns false
3131

32-
$writer = Writer::createFromFileObject(new SplTempFileObject());
32+
$writer = Writer::from(new SplTempFileObject());
3333
$writer->supportsStreamFilterOnRead(); //returns false, the API can not be used
3434
$writer->supportsStreamFilterOnWrite(); //returns false, the API can not be used
3535
```
@@ -53,11 +53,11 @@ Regardless of the stream filter API being supported by a specific CSV object, `g
5353
use League\Csv\Reader;
5454
use League\Csv\Writer;
5555

56-
$reader = Reader::createFromPath('/path/to/my/file.csv', 'r');
56+
$reader = Reader::from('/path/to/my/file.csv', 'r');
5757
$reader->supportsStreamFilter(); //returns true
5858
$reader->getStreamFilterMode(); //returns STREAM_FILTER_READ
5959

60-
$writer = Writer::createFromFileObject(new SplTempFileObject());
60+
$writer = Writer::from(new SplTempFileObject());
6161
$writer->supportsStreamFilter(); //returns false, the API can not be used
6262
$writer->getStreamFilterMode(); //returns STREAM_FILTER_WRITE
6363
```
@@ -116,7 +116,7 @@ use MyLib\Transcode;
116116
stream_filter_register('convert.utf8decode', Transcode::class);
117117
// 'MyLib\Transcode' is a class that extends PHP's php_user_filter class
118118

119-
$reader = Reader::createFromPath('/path/to/my/chinese.csv', 'r');
119+
$reader = Reader::from('/path/to/my/chinese.csv', 'r');
120120
if ($reader->supportsStreamFilterOnRead()) {
121121
$reader->appendStreamFilterOnRead('convert.utf8decode');
122122
$reader->appendStreamFilterOnRead('string.toupper');
@@ -149,7 +149,7 @@ use MyLib\Transcode;
149149
stream_filter_register('convert.utf8decode', Transcode::class);
150150
$fp = fopen('/path/to/my/chines.csv', 'r');
151151
stream_filter_append($fp, 'string.rot13'); //stream filter attached outside of League\Csv
152-
$reader = Reader::createFromStream($fp);
152+
$reader = Reader::from($fp);
153153
$reader->prependStreamFilterOnRead('convert.utf8decode');
154154
$reader->prependStreamFilterOnRead('string.toupper');
155155
$reader->hasStreamFilter('string.rot13'); //returns false
@@ -214,7 +214,7 @@ CallbackStreamFilter::isRegistered('string.tolower');
214214
//returns false - exits, is registered by PHP itself not by StreamFilter
215215
```
216216

217-
The class allows listing all the registered filter names by calling the
217+
The class lists all the registered filter names by calling the
218218

219219
```php
220220
CallbackStreamFilter::registeredFilterNames(); // returns a list
@@ -277,7 +277,7 @@ $csv = "title1,title2,title3\r".
277277
. "content11,content12,content13\r"
278278
. "content21,content22,content23\r";
279279

280-
$document = Reader::createFromString($csv);
280+
$document = Reader::fromString($csv);
281281
$document->setHeaderOffset(0);
282282

283283
CallbackStreamFilter::register(

docs/9.0/connections/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ shown in the example below:
4444
use League\Csv\Reader;
4545
use League\Csv\Writer;
4646

47-
$csv = Reader::createFromPath('/path/to/file.csv', 'r');
47+
$csv = Reader::from('/path/to/file.csv', 'r');
4848
$csv->setEscape(''); //required in PHP8.4+
4949

50-
$writer = Writer::createFromString();
50+
$writer = Writer::fromString();
5151
$writer->setEscape(''); //required in PHP8.4+
5252
```
5353

@@ -61,8 +61,8 @@ be done using the script below:
6161
use League\Csv\Reader;
6262
use League\Csv\Writer;
6363

64-
$csv = Reader::createFromPath('/path/to/file_with_escape_character.csv', 'r');
65-
$writer = Writer::createFromPath('/path/to/file_without_escape_character.csv', 'w');
64+
$csv = Reader::from('/path/to/file_with_escape_character.csv', 'r');
65+
$writer = Writer::from('/path/to/file_without_escape_character.csv', 'w');
6666
$writer->setEscape('');
6767
$writer->setDelimiter($csv->getDelimiter()); //we re-use the old document character controls
6868
$writer->setEnclosure($csv->getEnclosure()); //we re-use the old document character controls
@@ -88,7 +88,7 @@ use League\Csv\Exception;
8888
use League\Csv\Reader;
8989

9090
try {
91-
$csv = Reader::createFromPath('/path/to/file.csv', 'r');
91+
$csv = Reader::from('/path/to/file.csv', 'r');
9292
$csv->setDelimiter('toto');
9393
} catch (Exception $e) {
9494
echo $e->getMessage(), PHP_EOL;
@@ -104,7 +104,7 @@ use League\Csv\Exception;
104104
use League\Csv\Writer;
105105

106106
try {
107-
$csv = Writer::createFromFileObject(new SplFileObject('php://output', 'w'));
107+
$csv = Writer::from(new SplFileObject('php://output', 'w'));
108108
$csv->setEndOfLine("\r\n");
109109
$csv->insertOne(["foo", "bar"]);
110110
} catch (Exception | RuntimeException $e) {

docs/9.0/connections/output.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Use the `toString` method to return the full CSV content.
3131
```php
3232
use League\Csv\Reader;
3333

34-
$reader = Reader::createFromPath('/path/to/my/file.csv', 'r');
34+
$reader = Reader::from('/path/to/my/file.csv', 'r');
3535
echo $reader->toString();
3636
```
3737

@@ -44,7 +44,7 @@ If the CSV document is not seekable a `Exception` or a `RuntimeException` may be
4444
```php
4545
use League\Csv\Writer;
4646

47-
$csv = Writer::createFromFileObject(new SplFileObject('php://output', 'w'));
47+
$csv = Writer::from(new SplFileObject('php://output', 'w'));
4848
$csv->insertOne(['foo', 'bar']);
4949
echo $csv->toString();
5050
//throws a RuntimeException because the SplFileObject is not seekable
@@ -55,7 +55,7 @@ echo $csv->toString();
5555
```php
5656
use League\Csv\Writer;
5757

58-
$csv = Writer::createFromFileObject(new SplFileObject('php://output', 'w'));
58+
$csv = Writer::from(new SplFileObject('php://output', 'w'));
5959
$csv->insertOne(['foo', 'bar']);
6060
echo $csv;
6161
echo $csv->getContent();
@@ -87,7 +87,7 @@ header('Content-Type: text/csv; charset=UTF-8');
8787
header('Content-Description: File Transfer');
8888
header('Content-Disposition: attachment; filename="name-for-your-file.csv"');
8989

90-
$reader = Reader::createFromPath('/path/to/my/file.csv', 'r');
90+
$reader = Reader::from('/path/to/my/file.csv', 'r');
9191
$reader->download();
9292
die;
9393
```
@@ -97,7 +97,7 @@ die;
9797
```php
9898
use League\Csv\Reader;
9999

100-
$reader = Reader::createFromPath('file.csv');
100+
$reader = Reader::from('file.csv');
101101
$reader->download('name-for-your-file.csv');
102102
die;
103103
```
@@ -123,7 +123,7 @@ header('Content-Type: text/csv; charset=UTF-8');
123123
header('Content-Description: File Transfer');
124124
header('Content-Disposition: attachment; filename="name-for-your-file.csv"');
125125

126-
$reader = Reader::createFromPath('/path/to/huge/file.csv', 'r');
126+
$reader = Reader::from('/path/to/huge/file.csv', 'r');
127127
foreach ($reader->chunk(1024) as $chunk) {
128128
echo dechex(strlen($chunk))."\r\n$chunk\r\n";
129129
}
@@ -137,7 +137,7 @@ To avoid breaking the flow of your application, you should create a Response obj
137137
```php
138138
use League\Csv\Reader;
139139

140-
$reader = Reader::createFromPath('/path/to/my/file.csv', 'r');
140+
$reader = Reader::from('/path/to/my/file.csv', 'r');
141141
return new Response($reader->toString(), 200, [
142142
'Content-Encoding' => 'none',
143143
'Content-Type' => 'text/csv; charset=UTF-8',
@@ -161,7 +161,7 @@ use Symfony\Component\HttpFoundation\StreamedResponse;
161161
$stmt = $dbh->prepare("SELECT * FROM users");
162162
$stmt->setFetchMode(PDO::FETCH_ASSOC);
163163
$stmt->execute();
164-
$csv = Writer::createFromPath('php://temp', 'r+');
164+
$csv = Writer::from('php://temp', 'r+');
165165
$csv->insertAll($stmt);
166166

167167
//we create a callable to output the CSV in chunks

docs/9.0/converter/charset.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ $encoder = (new CharsetConverter())
5757
->outputEncoding('iso-8859-15')
5858
;
5959

60-
$writer = Writer::createFromPath('/path/to/your/csv/file.csv');
60+
$writer = Writer::from('/path/to/your/csv/file.csv');
6161
$writer->addFormatter($encoder);
6262

6363
$writer->insertOne(["foo", "bébé", "jouet"]);
@@ -86,7 +86,7 @@ The `CharsetConverter::addTo` static method:
8686
use League\Csv\CharsetConverter;
8787
use League\Csv\Writer;
8888

89-
$writer = Writer::createFromPath('/path/to/your/csv/file.csv');
89+
$writer = Writer::from('/path/to/your/csv/file.csv');
9090
CharsetConverter::addTo($writer, 'utf8', 'iso-8859-15');
9191

9292
$writer->insertOne(["foo", "bébé", "jouet"]);

docs/9.0/converter/json.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ ease storing the JSON in a file or displaying it in its full JSON string represe
219219
Here's a conversion example:
220220

221221
```php
222-
$document = Reader::createFromPath(__DIR__.'/test_files/prenoms.csv');
222+
$document = Reader::from(__DIR__.'/test_files/prenoms.csv');
223223
$document->setDelimiter(';');
224224
$document->setHeaderOffset(0);
225225

@@ -340,7 +340,7 @@ the total number of bytes sent just like the `JsonConverter::save` method and en
340340
use League\Csv\Reader;
341341
use League\Csv\JsonConverter;
342342

343-
$reader = Reader::createFromPath('file.csv');
343+
$reader = Reader::from('file.csv');
344344
$reader->setHeaderOffset(0);
345345

346346
header('Cache-Control: no-cache, no-store, must-revalidate');
@@ -364,7 +364,7 @@ If you want to reduce the number of headers to write you can specify the downloa
364364
use League\Csv\Reader;
365365
use League\Csv\JsonConverter;
366366

367-
$reader = Reader::createFromPath('file.csv');
367+
$reader = Reader::from('file.csv');
368368
$reader->setHeaderOffset(0);
369369

370370
header('Cache-Control: no-cache, no-store, must-revalidate');

docs/9.0/converter/xml.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ use League\Csv\XMLConverter;
134134
use League\Csv\Statement;
135135
use League\Csv\Reader;
136136

137-
$csv = Reader::createFromPath('/path/to/prenoms.csv', 'r');
137+
$csv = Reader::from('/path/to/prenoms.csv', 'r');
138138
$csv->setDelimiter(';');
139139
$csv->setHeaderOffset(0);
140140

@@ -244,7 +244,7 @@ use League\Csv\XMLConverter;
244244
use League\Csv\Statement;
245245
use League\Csv\Reader;
246246

247-
$csv = Reader::createFromPath('/path/to/prenoms.csv', 'r');
247+
$csv = Reader::from('/path/to/prenoms.csv', 'r');
248248
$csv->setDelimiter(';');
249249
$csv->setHeaderOffset(0);
250250

@@ -304,7 +304,7 @@ the total number of bytes sent just like the `XMLConverter::save` method and ena
304304
use League\Csv\Reader;
305305
use League\Csv\XMLConverter;
306306

307-
$reader = Reader::createFromPath('file.csv');
307+
$reader = Reader::from('file.csv');
308308
$reader->setHeaderOffset(0);
309309

310310
header('Cache-Control: no-cache, no-store, must-revalidate');
@@ -330,7 +330,7 @@ To download the generated XML on the fly you can use the `XMLConverter::download
330330
use League\Csv\Reader;
331331
use League\Csv\XMLConverter;
332332

333-
$reader = Reader::createFromPath('file.csv');
333+
$reader = Reader::from('file.csv');
334334
$reader->setHeaderOffset(0);
335335

336336
header('Cache-Control: no-cache, no-store, must-revalidate');
@@ -350,7 +350,7 @@ the method optional arguments.
350350
use League\Csv\Reader;
351351
use League\Csv\XMLConverter;
352352

353-
$reader = Reader::createFromPath('file.csv');
353+
$reader = Reader::from('file.csv');
354354
$reader->setHeaderOffset(0);
355355

356356
header('Cache-Control: no-cache, no-store, must-revalidate');

docs/9.0/extensions/doctrine.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ since version `9.16.0` you can write:
2424
use League\Csv\Reader;
2525
use League\Csv\Statement;
2626

27-
$csv = Reader::createFromPath('/path/to/my/file.csv');
27+
$csv = Reader::from('/path/to/my/file.csv');
2828
$csv->setHeaderOffset(0);
2929
$csv->setDelimiter(';');
3030

@@ -54,7 +54,7 @@ use Doctrine\Common\Collections\Criteria;
5454
use League\Csv\Doctrine as CsvDoctrine;
5555
use League\Csv\Reader;
5656

57-
$csv = Reader::createFromPath('/path/to/my/file.csv');
57+
$csv = Reader::from('/path/to/my/file.csv');
5858
$csv->setHeaderOffset(0);
5959
$csv->setDelimiter(';');
6060

@@ -98,7 +98,7 @@ composer require league/csv-doctrine
9898
use League\Csv\Doctrine\RecordCollection;
9999
use League\Csv\Reader;
100100

101-
$csv = Reader::createFromPath('/path/to/my/file.csv');
101+
$csv = Reader::from('/path/to/my/file.csv');
102102
$csv->setHeaderOffset(0);
103103
$csv->setDelimiter(';');
104104

@@ -110,7 +110,7 @@ $collection = new RecordCollection($csv);
110110
```php
111111
<?php
112112

113-
$csv = Reader::createFromPath('/path/to/my/file.csv');
113+
$csv = Reader::from('/path/to/my/file.csv');
114114
$csv->setHeaderOffset(0);
115115
$csv->setDelimiter(';');
116116

@@ -129,7 +129,7 @@ use Doctrine\Common\Collections\Criteria;
129129
use League\Csv\Doctrine\CriteriaConverter;
130130
use League\Csv\Reader;
131131

132-
$csv = Reader::createFromPath('/path/to/my/file.csv');
132+
$csv = Reader::from('/path/to/my/file.csv');
133133
$csv->setHeaderOffset(0);
134134
$csv->setDelimiter(';');
135135

0 commit comments

Comments
 (0)