PHP Class Box\Spout\Reader\CSV\ReaderOptions

Inheritance: extends Box\Spout\Reader\Common\ReaderOptions
Afficher le fichier Open project: box/spout Class Usage Examples

Protected Properties

Свойство Type Description
$encoding Encoding of the CSV file to be read
$endOfLineCharacter Defines the End of line
$fieldDelimiter Defines the character used to delimit fields (one character only)
$fieldEnclosure Defines the character used to enclose fields (one character only)

Méthodes publiques

Méthode Description
getEncoding ( ) : string
getEndOfLineCharacter ( ) : string
getFieldDelimiter ( ) : string
getFieldEnclosure ( ) : string
setEncoding ( string $encoding ) : ReaderOptions Sets the encoding of the CSV file to be read.
setEndOfLineCharacter ( string $endOfLineCharacter ) : ReaderOptions Sets the EOL for the CSV.
setFieldDelimiter ( string $fieldDelimiter ) : ReaderOptions Sets the field delimiter for the CSV.
setFieldEnclosure ( string $fieldEnclosure ) : ReaderOptions Sets the field enclosure for the CSV.

Method Details

getEncoding() public méthode

public getEncoding ( ) : string
Résultat string

getEndOfLineCharacter() public méthode

public getEndOfLineCharacter ( ) : string
Résultat string EOL for the CSV

getFieldDelimiter() public méthode

public getFieldDelimiter ( ) : string
Résultat string

getFieldEnclosure() public méthode

public getFieldEnclosure ( ) : string
Résultat string

setEncoding() public méthode

Needs to be called before opening the reader.
public setEncoding ( string $encoding ) : ReaderOptions
$encoding string Encoding of the CSV file to be read
Résultat ReaderOptions

setEndOfLineCharacter() public méthode

Needs to be called before opening the reader.
public setEndOfLineCharacter ( string $endOfLineCharacter ) : ReaderOptions
$endOfLineCharacter string used to properly get lines from the CSV file.
Résultat ReaderOptions

setFieldDelimiter() public méthode

Needs to be called before opening the reader.
public setFieldDelimiter ( string $fieldDelimiter ) : ReaderOptions
$fieldDelimiter string Character that delimits fields
Résultat ReaderOptions

setFieldEnclosure() public méthode

Needs to be called before opening the reader.
public setFieldEnclosure ( string $fieldEnclosure ) : ReaderOptions
$fieldEnclosure string Character that enclose fields
Résultat ReaderOptions

Property Details

$encoding protected_oe property

Encoding of the CSV file to be read
protected $encoding

$endOfLineCharacter protected_oe property

Defines the End of line
protected $endOfLineCharacter

$fieldDelimiter protected_oe property

Defines the character used to delimit fields (one character only)
protected $fieldDelimiter

$fieldEnclosure protected_oe property

Defines the character used to enclose fields (one character only)
protected $fieldEnclosure