PHP Класс Box\Spout\Reader\CSV\Reader

Наследование: extends Box\Spout\Reader\AbstractReader
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$filePointer Pointer to the file to be written
$originalAutoDetectLineEndings Original value for the "auto_detect_line_endings" INI value
$sheetIterator To iterator over the CSV unique "sheet"

Открытые методы

Метод Описание
setEncoding ( string $encoding ) : Reader Sets the encoding of the CSV file to be read.
setEndOfLineCharacter ( string $endOfLineCharacter ) : Reader Sets the EOL for the CSV.
setFieldDelimiter ( string $fieldDelimiter ) : Reader Sets the field delimiter for the CSV.
setFieldEnclosure ( string $fieldEnclosure ) : Reader Sets the field enclosure for the CSV.

Защищенные методы

Метод Описание
closeReader ( ) : void Closes the reader. To be used after reading the file.
doesSupportStreamWrapper ( ) : boolean Returns whether stream wrappers are supported
getConcreteSheetIterator ( ) : SheetIterator Returns an iterator to iterate over sheets.
getOptions ( ) : ReaderOptions Returns the reader's current options
openReader ( string $filePath ) : void Opens the file at the given path to make it ready to be read.

Описание методов

closeReader() защищенный Метод

Closes the reader. To be used after reading the file.
protected closeReader ( ) : void
Результат void

doesSupportStreamWrapper() защищенный Метод

Returns whether stream wrappers are supported
protected doesSupportStreamWrapper ( ) : boolean
Результат boolean

getConcreteSheetIterator() защищенный Метод

Returns an iterator to iterate over sheets.
protected getConcreteSheetIterator ( ) : SheetIterator
Результат SheetIterator To iterate over sheets

getOptions() защищенный Метод

Returns the reader's current options
protected getOptions ( ) : ReaderOptions
Результат ReaderOptions

openReader() защищенный Метод

If setEncoding() was not called, it assumes that the file is encoded in UTF-8.
protected openReader ( string $filePath ) : void
$filePath string Path of the CSV file to be read
Результат void

setEncoding() публичный Метод

Needs to be called before opening the reader.
public setEncoding ( string $encoding ) : Reader
$encoding string Encoding of the CSV file to be read
Результат Reader

setEndOfLineCharacter() публичный Метод

Needs to be called before opening the reader.
public setEndOfLineCharacter ( string $endOfLineCharacter ) : Reader
$endOfLineCharacter string used to properly get lines from the CSV file.
Результат Reader

setFieldDelimiter() публичный Метод

Needs to be called before opening the reader.
public setFieldDelimiter ( string $fieldDelimiter ) : Reader
$fieldDelimiter string Character that delimits fields
Результат Reader

setFieldEnclosure() публичный Метод

Needs to be called before opening the reader.
public setFieldEnclosure ( string $fieldEnclosure ) : Reader
$fieldEnclosure string Character that enclose fields
Результат Reader

Описание свойств

$filePointer защищенное свойство

Pointer to the file to be written
protected $filePointer

$originalAutoDetectLineEndings защищенное свойство

Original value for the "auto_detect_line_endings" INI value
protected $originalAutoDetectLineEndings

$sheetIterator защищенное свойство

To iterator over the CSV unique "sheet"
protected $sheetIterator