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 PHPExcel object;

Type

boolean

$_preCalculateFormulas

$_preCalculateFormulas : boolean

Pre-calculate formulas Forces PHPExcel 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

$_useDiskCaching

$_useDiskCaching : boolean

Use disk caching where possible?

Type

boolean

$_diskCachingDirectory

$_diskCachingDirectory : string

Disk caching directory

Type

string

$_phpExcel

$_phpExcel : \PHPExcel

PHPExcel object

Type

\PHPExcel

$_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

$_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 PHPExcel object.

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

Returns

boolean

setIncludeCharts()

setIncludeCharts(boolean  $pValue = FALSE) : \PHPExcel_Writer_IWriter

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

Set to false (the default) to ignore charts.

Parameters

boolean $pValue

Returns

\PHPExcel_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 PHPExcel, but slower when opening the resulting file in MS Excel, because Excel has to recalculate the formulae itself

Returns

boolean

setPreCalculateFormulas()

setPreCalculateFormulas(boolean  $pValue = TRUE) : \PHPExcel_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

\PHPExcel_Writer_IWriter

getUseDiskCaching()

getUseDiskCaching() : boolean

Get use disk caching where possible?

Returns

boolean

setUseDiskCaching()

setUseDiskCaching(boolean  $pValue = FALSE, string  $pDirectory = NULL) : \PHPExcel_Writer_Excel2007

Set use disk caching where possible?

Parameters

boolean $pValue
string $pDirectory

Disk caching directory

Throws

\PHPExcel_Writer_Exception

when directory does not exist

Returns

\PHPExcel_Writer_Excel2007

getDiskCachingDirectory()

getDiskCachingDirectory() : string

Get disk caching directory

Returns

string

__construct()

__construct(\PHPExcel  $phpExcel) 

Create a new PHPExcel_Writer_CSV

Parameters

\PHPExcel $phpExcel

PHPExcel object

save()

save(string  $pFilename = null) 

Save PHPExcel to file

@param string $pFilename Name of the file to save

Parameters

string $pFilename

Throws

\PHPExcel_Writer_Exception

getDelimiter()

getDelimiter() : string

Get delimiter

Returns

string

setDelimiter()

setDelimiter(string  $pValue = ',') : \PHPExcel_Writer_CSV

Set delimiter

Parameters

string $pValue

Delimiter, defaults to ,

Returns

\PHPExcel_Writer_CSV

getEnclosure()

getEnclosure() : string

Get enclosure

Returns

string

setEnclosure()

setEnclosure(string  $pValue = '"') : \PHPExcel_Writer_CSV

Set enclosure

Parameters

string $pValue

Enclosure, defaults to "

Returns

\PHPExcel_Writer_CSV

getLineEnding()

getLineEnding() : string

Get line ending

Returns

string

setLineEnding()

setLineEnding(string  $pValue = PHP_EOL) : \PHPExcel_Writer_CSV

Set line ending

Parameters

string $pValue

Line ending, defaults to OS line ending (PHP_EOL)

Returns

\PHPExcel_Writer_CSV

getUseBOM()

getUseBOM() : boolean

Get whether BOM should be used

Returns

boolean

setUseBOM()

setUseBOM(boolean  $pValue = false) : \PHPExcel_Writer_CSV

Set whether BOM should be used

Parameters

boolean $pValue

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

Returns

\PHPExcel_Writer_CSV

getExcelCompatibility()

getExcelCompatibility() : boolean

Get whether the file should be saved with full Excel Compatibility

Returns

boolean

setExcelCompatibility()

setExcelCompatibility(boolean  $pValue = false) : \PHPExcel_Writer_CSV

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

\PHPExcel_Writer_CSV

getSheetIndex()

getSheetIndex() : integer

Get sheet index

Returns

integer

setSheetIndex()

setSheetIndex(integer  $pValue) : \PHPExcel_Writer_CSV

Set sheet index

Parameters

integer $pValue

Sheet index

Returns

\PHPExcel_Writer_CSV

_writeLine()

_writeLine(mixed  $pFileHandle = null, array  $pValues = null) 

Write line to CSV file

Parameters

mixed $pFileHandle

PHP filehandle

array $pValues

Array containing values in a row

Throws

\PHPExcel_Writer_Exception