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

$_str_total

$_str_total : int

Total number of shared strings in workbook

Type

int

$_str_unique

$_str_unique : int

Number of unique shared strings in workbook

Type

int

$_str_table

$_str_table : array

Array of unique shared strings in workbook

Type

array

$_colors

$_colors : array

Color cache. Mapping between RGB value and color index.

Type

array

$_IDCLs

$_IDCLs : array

Identifier clusters for drawings. Used in MSODRAWINGGROUP record.

Type

array

$_summaryInformation

$_summaryInformation : array

Basic OLE object summary information

Type

array

$_documentSummaryInformation

$_documentSummaryInformation : array

Extended OLE object document summary information

Type

array

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_Excel5

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 —

setTempDir()

setTempDir(string  $pValue = '') : \PHPExcel_Writer_Excel5

Set temporary storage directory

Parameters

string $pValue

Temporary storage directory

Throws

\PHPExcel_Writer_Exception

when directory does not exist

Returns

\PHPExcel_Writer_Excel5 —

_buildWorksheetEschers()

_buildWorksheetEschers() : mixed

Build the Worksheet Escher objects

Returns

mixed —

_buildWorkbookEscher()

_buildWorkbookEscher() : mixed

Build the Escher object corresponding to the MSODRAWINGGROUP record

Returns

mixed —

_writeDocumentSummaryInformation()

_writeDocumentSummaryInformation() : string

Build the OLE Part for DocumentSummary Information

Returns

string —

_writeSummaryInformation()

_writeSummaryInformation() : string

Build the OLE Part for Summary Information

Returns

string —