\PhpOffice\PhpSpreadsheet\WriterCsv

Summary

Methods

Properties

Constants

getIncludeCharts()
setIncludeCharts()
getPreCalculateFormulas()
setPreCalculateFormulas()
getUseDiskCaching()
setUseDiskCaching()
getDiskCachingDirectory()
openFileHandle()
__construct()
save()
getDelimiter()
setDelimiter()
getEnclosure()
setEnclosure()
getLineEnding()
setLineEnding()
getUseBOM()
setUseBOM()
getIncludeSeparatorLine()
setIncludeSeparatorLine()
getExcelCompatibility()
setExcelCompatibility()
getSheetIndex()
setSheetIndex()

No public properties found

No constants found

maybeCloseFileHandle()

$includeCharts
$preCalculateFormulas
$fileHandle

N/A

writeLine()

$useDiskCaching
$diskCachingDirectory
$shouldCloseFile
$spreadsheet
$delimiter
$enclosure
$lineEnding
$sheetIndex
$useBOM
$includeSeparatorLine
$excelCompatibility

N/A

Properties

$includeCharts

$includeCharts : boolean

Write charts that are defined in the workbook? Identifies whether the Writer should write definitions for any charts that exist in the PhpSpreadsheet object;.

Type

boolean

$preCalculateFormulas

$preCalculateFormulas : boolean

Pre-calculate formulas Forces PhpSpreadsheet to recalculate all formulae in a workbook when saving, so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet viewer when opening the file.

Type

boolean

$fileHandle

$fileHandle : resource

Type

resource

$useDiskCaching

$useDiskCaching : boolean

Use disk caching where possible?

Type

boolean

$diskCachingDirectory

$diskCachingDirectory : string

Disk caching directory.

Type

string

$shouldCloseFile

$shouldCloseFile : boolean

Type

boolean

$spreadsheet

$spreadsheet : \PhpOffice\PhpSpreadsheet\Spreadsheet

PhpSpreadsheet object.

Type

\PhpOffice\PhpSpreadsheet\Spreadsheet

$delimiter

$delimiter : string

Delimiter.

Type

string

$enclosure

$enclosure : string

Enclosure.

Type

string

$lineEnding

$lineEnding : string

Line ending.

Type

string

$sheetIndex

$sheetIndex : integer

Sheet index to write.

Type

integer

$useBOM

$useBOM : boolean

Whether to write a BOM (for UTF8).

Type

boolean

$includeSeparatorLine

$includeSeparatorLine : boolean

Whether to write a Separator line as the first line of the file sep=x.

Type

boolean

$excelCompatibility

$excelCompatibility : boolean

Whether to write a fully Excel compatible CSV file.

Type

boolean

Methods

getIncludeCharts()

getIncludeCharts() : boolean

Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object.

If false (the default) it will ignore any charts defined in the PhpSpreadsheet object.

Returns

boolean

setIncludeCharts()

setIncludeCharts(boolean  $pValue) : \PhpOffice\PhpSpreadsheet\Writer\IWriter

Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object.

Set to false (the default) to ignore charts.

Parameters

boolean

$pValue

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter

getPreCalculateFormulas()

getPreCalculateFormulas() : boolean

Get Pre-Calculate Formulas flag If this is true (the default), then the writer will recalculate all formulae in a workbook when saving, so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet viewer when opening the file If false, then formulae are not calculated on save. This is faster for saving in PhpSpreadsheet, but slower when opening the resulting file in MS Excel, because Excel has to recalculate the formulae itself.

Returns

boolean

setPreCalculateFormulas()

setPreCalculateFormulas(boolean  $pValue) : \PhpOffice\PhpSpreadsheet\Writer\IWriter

Set Pre-Calculate Formulas Set to true (the default) to advise the Writer to calculate all formulae on save Set to false to prevent precalculation of formulae on save.

Parameters

boolean

$pValue

Pre-Calculate Formulas?

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter

getUseDiskCaching()

getUseDiskCaching() : boolean

Get use disk caching where possible?

Returns

boolean

setUseDiskCaching()

setUseDiskCaching(boolean  $pValue, string  $pDirectory = null) : \PhpOffice\PhpSpreadsheet\Writer\IWriter

Set use disk caching where possible?

Parameters

boolean	$pValue
string	$pDirectory	Disk caching directory

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter

getDiskCachingDirectory()

getDiskCachingDirectory() : string

Get disk caching directory.

Returns

string

openFileHandle()

openFileHandle(resource|string  $filename)

Open file handle.

Parameters

resource|string

$filename

__construct()

__construct(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet)

Create a new CSV.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet

$spreadsheet

Spreadsheet object

save()

save(resource|string  $pFilename)

Save PhpSpreadsheet to file.

Parameters

resource|string

$pFilename

getDelimiter()

getDelimiter() : string

Get delimiter.

Returns

string

setDelimiter()

setDelimiter(string  $pValue) : $this

Set delimiter.

Parameters

string

$pValue

Delimiter, defaults to ','

Returns

$this

getEnclosure()

getEnclosure() : string

Get enclosure.

Returns

string

setEnclosure()

setEnclosure(string  $pValue) : $this

Set enclosure.

Parameters

string

$pValue

Enclosure, defaults to "

Returns

$this

getLineEnding()

getLineEnding() : string

Get line ending.

Returns

string

setLineEnding()

setLineEnding(string  $pValue) : $this

Set line ending.

Parameters

string

$pValue

Line ending, defaults to OS line ending (PHP_EOL)

Returns

$this

getUseBOM()

getUseBOM() : boolean

Get whether BOM should be used.

Returns

boolean

setUseBOM()

setUseBOM(boolean  $pValue) : $this

Set whether BOM should be used.

Parameters

boolean

$pValue

Use UTF-8 byte-order mark? Defaults to false

Returns

$this

getIncludeSeparatorLine()

getIncludeSeparatorLine() : boolean

Get whether a separator line should be included.

Returns

boolean

setIncludeSeparatorLine()

setIncludeSeparatorLine(boolean  $pValue) : $this

Set whether a separator line should be included as the first line of the file.

Parameters

boolean

$pValue

Use separator line? Defaults to false

Returns

$this

getExcelCompatibility()

getExcelCompatibility() : boolean

Get whether the file should be saved with full Excel Compatibility.

Returns

boolean

setExcelCompatibility()

setExcelCompatibility(boolean  $pValue) : $this

Set whether the file should be saved with full Excel Compatibility.

Parameters

boolean

$pValue

Set the file to be written as a fully Excel compatible csv file Note that this overrides other settings such as useBOM, enclosure and delimiter

Returns

$this

getSheetIndex()

getSheetIndex() : integer

Get sheet index.

Returns

integer

setSheetIndex()

setSheetIndex(integer  $pValue) : $this

Set sheet index.

Parameters

integer

$pValue

Sheet index

Returns

$this

maybeCloseFileHandle()

maybeCloseFileHandle()

Close file handle only if we opened it ourselves.

writeLine()

writeLine(resource  $pFileHandle, array  $pValues)

Write line to CSV file.

Parameters

resource	$pFileHandle	PHP filehandle
array	$pValues	Array containing values in a row