Properties

$_includeCharts

$_includeCharts : bool

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

bool

$_preCalculateFormulas

$_preCalculateFormulas : bool

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

bool

$_useDiskCaching

$_useDiskCaching : bool

Use disk caching where possible?

Type

bool

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

Sheet index to write

Type

int

$_useBOM

$_useBOM : bool

Whether to write a BOM (for UTF8).

Type

bool

$_excelCompatibility

$_excelCompatibility : bool

Whether to write a fully Excel compatible CSV file.

Type

bool

Methods

getIncludeCharts()

getIncludeCharts() : bool

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

bool —

setIncludeCharts()

setIncludeCharts(bool  $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

bool $pValue

Returns

\PHPExcel_Writer_IWriter —

getPreCalculateFormulas()

getPreCalculateFormulas() : bool

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

bool —

setPreCalculateFormulas()

setPreCalculateFormulas(bool  $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

bool $pValue

Pre-Calculate Formulas?

Returns

\PHPExcel_Writer_IWriter —

getUseDiskCaching()

getUseDiskCaching() : bool

Get use disk caching where possible?

Returns

bool —

setUseDiskCaching()

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

Set use disk caching where possible?

Parameters

bool $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) : mixed

Create a new PHPExcel_Writer_CSV

Parameters

\PHPExcel $phpExcel

PHPExcel object

Returns

mixed —

save()

save(string  $pFilename = null) : mixed

Save PHPExcel to file

Parameters

string $pFilename

Throws

\PHPExcel_Writer_Exception

Returns

mixed —

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() : bool

Get whether BOM should be used

Returns

bool —

setUseBOM()

setUseBOM(bool  $pValue = false) : \PHPExcel_Writer_CSV

Set whether BOM should be used

Parameters

bool $pValue

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

Returns

\PHPExcel_Writer_CSV —

getExcelCompatibility()

getExcelCompatibility() : bool

Get whether the file should be saved with full Excel Compatibility

Returns

bool —

setExcelCompatibility()

setExcelCompatibility(bool  $pValue = false) : \PHPExcel_Writer_CSV

Set whether the file should be saved with full Excel Compatibility

Parameters

bool $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() : int

Get sheet index

Returns

int —

setSheetIndex()

setSheetIndex(int  $pValue) : \PHPExcel_Writer_CSV

Set sheet index

Parameters

int $pValue

Sheet index

Returns

\PHPExcel_Writer_CSV —

_writeLine()

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

Write line to CSV file

Parameters

mixed $pFileHandle

PHP filehandle

array $pValues

Array containing values in a row

Throws

\PHPExcel_Writer_Exception

Returns

mixed —