\League\CsvWriter

__destruct()

__destruct() 

{@inheritdoc}

__clone()

__clone() 

{@inheritdoc}

createFromFileObject()

createFromFileObject(\SplFileObject  $file) : static

Return a new instance from a SplFileObject.

Parameters

Returns

createFromStream()

createFromStream(resource  $stream) : static

Return a new instance from a PHP resource stream.

Parameters

Returns

createFromString()

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

Return a new instance from a string.

Parameters

Returns

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

Returns

getDelimiter()

getDelimiter() 

Returns the current field delimiter.

getEnclosure()

getEnclosure() 

Returns the current field enclosure.

getPathname()

getPathname() 

Returns the pathname of the underlying document.

getEscape()

getEscape() 

Returns the current field escape character.

getOutputBOM()

getOutputBOM() 

Returns the BOM sequence in use on Output methods.

getInputBOM()

getInputBOM() 

Returns the BOM sequence of the given CSV.

getStreamFilterMode()

getStreamFilterMode() 

Returns the stream filter mode.

supportsStreamFilter()

supportsStreamFilter() 

Tells whether the stream filter capabilities can be used.

hasStreamFilter()

hasStreamFilter(\League\Csv\string  $filtername) 

Tell whether the specify stream filter is attach to the current stream.

Parameters

isInputBOMIncluded()

isInputBOMIncluded() 

Tells whether the BOM can be stripped if presents.

chunk()

chunk(integer  $length) 

Retuns the CSV document as a Generator of string chunk.

Parameters

Throws

\League\Csv\Exception

if the number of bytes is lesser than 1

__toString()

__toString() 

DEPRECATION WARNING! This method will be removed in the next major point release.

getContent()

getContent() 

Retrieves the CSV content.

output()

output(\League\Csv\string  $filename = null) : integer

Outputs all data on the CSV file.

Parameters

Returns

Returns the number of characters read from the handle and passed through to the output.

setDelimiter()

setDelimiter(\League\Csv\string  $delimiter) : static

Sets the field delimiter.

Parameters

Throws

\League\Csv\Exception

If the Csv control character is not one character only.

Returns

setEnclosure()

setEnclosure(\League\Csv\string  $enclosure) : static

Sets the field enclosure.

Parameters

Throws

\League\Csv\Exception

If the Csv control character is not one character only.

Returns

setEscape()

setEscape(\League\Csv\string  $escape) : static

Sets the field escape character.

Parameters

Throws

\League\Csv\Exception

If the Csv control character is not one character only.

Returns

skipInputBOM()

skipInputBOM() : static

Enables BOM Stripping.

Returns

includeInputBOM()

includeInputBOM() : static

Disables skipping Input BOM.

Returns

setOutputBOM()

setOutputBOM(\League\Csv\string  $str) : static

Sets the BOM sequence to prepend the CSV on output.

Parameters

Returns

addStreamFilter()

addStreamFilter(\League\Csv\string  $filtername, null|mixed  $params = null) : static

append a stream filter.

Parameters

Throws

\League\Csv\Exception

If the stream filter API can not be used

Returns

getNewline()

getNewline() 

Returns the current newline sequence characters.

getFlushThreshold()

getFlushThreshold() : integer|null

Get the flush threshold.

Returns

insertAll()

insertAll(\Traversable|array  $records) 

Adds multiple records to the CSV document.

Parameters

insertOne()

insertOne(array  $record) 

Adds a single record to a CSV document.

A record is an array that can contains scalar types values, NULL values or objects implementing the __toString method.

Parameters

Throws

\League\Csv\CannotInsertRecord

If the record can not be inserted

addFormatter()

addFormatter(callable  $formatter) 

Adds a record formatter.

Parameters

addValidator()

addValidator(callable  $validator, \League\Csv\string  $validator_name) 

Adds a record validator.

Parameters

setNewline()

setNewline(\League\Csv\string  $newline) 

Sets the newline sequence.

Parameters

setFlushThreshold()

setFlushThreshold(integer|null  $threshold) 

Set the flush threshold.

Parameters

Throws

\League\Csv\Exception

if the threshold is a integer lesser than 1

__construct()

__construct(\SplFileObject|\League\Csv\Stream  $document) 

New instance.

Parameters

resetProperties()

resetProperties() 

Reset dynamic object properties to improve performance.

sendHeaders()

sendHeaders(\League\Csv\string  $filename) 

Send the CSV headers.

Adapted from Symfony\Component\HttpFoundation\ResponseHeaderBag::makeDisposition

Parameters

Throws

\League\Csv\Exception

if the submitted header is invalid according to RFC 6266

addRecord()

addRecord(array  $record) : integer|false

Adds a single record to a CSV Document using PHP algorithm.

Parameters

Returns

addRFC4180CompliantRecord()

addRFC4180CompliantRecord(array  $record) : integer|false

Adds a single record to a CSV Document using RFC4180 algorithm.

Parameters

Returns

formatRecord()

formatRecord(array  $record, callable  $formatter) 

Format a record.

The returned array must contain

• scalar types values,
• NULL values,
• or objects implementing the __toString() method.

Parameters

validateRecord()

validateRecord(array  $record) 

Validate a record.

Parameters

Throws

\League\Csv\CannotInsertRecord

If the validation failed

consolidate()

consolidate() 

Apply post insertion actions.