\League\CsvStream

__construct()

__construct(resource  $stream) 

New instance.

Parameters

__destruct()

__destruct() 

{@inheritdoc}

__clone()

__clone() 

{@inheritdoc}

__debugInfo()

__debugInfo() 

{@inheritdoc}

createFromPath()

createFromPath(\League\Csv\string  $path, \League\Csv\string  $open_mode = 'r', resource|null  $context = null) : static

Return a new instance from a file path.

Parameters

Throws

\League\Csv\Exception

if the stream resource can not be created

Returns

createFromString()

createFromString(\League\Csv\string  $content = '') : static

Return a new instance from a string.

Parameters

Returns

getPathname()

getPathname() 

Return the URI of the underlying stream.

appendFilter()

appendFilter(\League\Csv\string  $filtername, \League\Csv\int  $read_write, null|mixed  $params = null) 

append a filter.

Parameters

Throws

\League\Csv\Exception

if the filter can not be appended

setCsvControl()

setCsvControl(\League\Csv\string  $delimiter = ',', \League\Csv\string  $enclosure = '"', \League\Csv\string  $escape = '\\') 

Set CSV control.

Parameters

getCsvControl()

getCsvControl() : array<mixed,string>

Set CSV control.

Returns

setFlags()

setFlags(\League\Csv\int  $flags) 

Set CSV stream flags.

Parameters

fputcsv()

fputcsv(array  $fields, \League\Csv\string  $delimiter = ',', \League\Csv\string  $enclosure = '"', \League\Csv\string  $escape = '\\') : integer|false

Write a field array as a CSV line.

Parameters

Returns

key()

key() : integer

Get line number.

Returns

next()

next() 

Read next line.

rewind()

rewind() 

Rewind the file to the first line.

Throws

\League\Csv\Exception

if the stream resource is not seekable

valid()

valid() : boolean

Not at EOF.

Returns

current()

current() 

Retrieves the current line of the file.

seek()

seek(integer  $position) 

Seek to specified line.

Parameters

Throws

\League\Csv\Exception

if the position is negative

fpassthru()

fpassthru() : integer

Output all remaining data on a file pointer.

Returns

fread()

fread(integer  $length) : string|false

Read from file.

Parameters

Returns

fgets()

fgets() : string|false

Gets a line from file.

Returns

fseek()

fseek(\League\Csv\int  $offset, \League\Csv\int  $whence = \SEEK_SET) : integer

Seek to a position.

Parameters

Throws

\League\Csv\Exception

if the stream resource is not seekable

Returns

fwrite()

fwrite(\League\Csv\string  $str, \League\Csv\int  $length = null) : integer|false

Write to stream.

Parameters

Returns

fflush()

fflush() : boolean

Flushes the output to a file.

Returns

filterControl()

filterControl(\League\Csv\string  $delimiter, \League\Csv\string  $enclosure, \League\Csv\string  $escape, \League\Csv\string  $caller) 

Filter Csv control characters.

Parameters

Throws

\League\Csv\Exception

If the Csv control character is not one character only.

getCurrentRecord()

getCurrentRecord() : array|false

Retrieves the current line as a CSV Record.

Returns