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
|
---
layout: default
title: Loading CSV documents
---
# Document loading
Because CSV documents come in different forms we use named constructors to offer several ways to load them.
<p class="message-warning">Since version <code>9.1.0</code> non-seekable CSV documents can be used but <strong>exceptions will be thrown if features requiring a seekable CSV document are used.</strong></p>
## Loading from a string
```php
public static AbstractCsv::createFromString(string $content = ''): self
```
Creates a new object from a given string.
```php
use League\Csv\Reader;
use League\Csv\Writer;
$reader = Reader::createFromString('john,doe,john.doe@example.com');
$writer = Writer::createFromString('john,doe,john.doe@example.com');
```
<p class="message-notice">Since version <code>9.2.0</code> the <code>$content</code> argument default value is an empty string to ease usage.</p>
## Loading from a file path
```php
public static AbstractCsv::createFromPath(
string $path,
string $open_mode = 'r+',
resource $context = null
): self
```
Creates a new object *à la* `fopen`.
```php
use League\Csv\Reader;
use League\Csv\Writer;
$reader = Reader::createFromPath('/path/to/your/csv/file.csv', 'r');
$writer = Writer::createFromPath('/path/to/your/csv/file.csv', 'w');
```
<div class="message-notice">
Starting with version <code>9.1.0</code>, <code>$open_mode</code> defaults to:
<ul>
<li><code>r+</code> for the <code>Writer</code> class</li>
<li><code>r</code> for the <code>Reader</code> class</li>
</ul>
</div>
## Loading from a resource stream
```php
public static AbstractCsv::createFromStream(resource $stream): self
```
Creates a new object from a stream resource.
```php
use League\Csv\Reader;
use League\Csv\Writer;
$reader = Reader::createFromStream(fopen('/path/to/the/file.csv', 'r+'));
$writer = Writer::createFromStream(tmpfile());
```
<p class="message-notice">Prior to version <code>9.1.0</code>, the method would throw a <code>League\Csv\Exception</code> for a non-seekable stream resource.</p>
## Loading from a SplFileObject object
```php
public static AbstractCsv::createFromFileObject(SplFileObject $file): self
```
Creates a new object from a `SplFileObject` object.
```php
use League\Csv\Reader;
use League\Csv\Writer;
$reader = Reader::createFromFileObject(new SplFileObject('/path/to/your/csv/file.csv'));
$writer = Writer::createFromFileObject(new SplTempFileObject());
```
## Accessing the CSV document path
<p class="message-notice">New in version <code>9.2.0</code></p>
```php
public AbstractCsv::getPathname(): string
```
Once instantiated, the `getPathname` method returns the pathname of the underlying document.
```php
use League\Csv\Reader;
use League\Csv\Writer;
Reader::createFromFileObject(new SplFileObject('/path/to/your/csv/file.csv'))->getPathname();
//returns '/path/to/your/csv/file.csv'
Writer::createFromFileObject(new SplTempFileObject())->getPathname();
//returns php://temp
```
|
