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 PhpSpreadsheet object;.

Type

bool

$preCalculateFormulas

$preCalculateFormulas : bool

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

bool

$fileHandle

$fileHandle : resource

Type

resource

$useDiskCaching

$useDiskCaching : bool

Use disk caching where possible?

Type

bool

$diskCachingDirectory

$diskCachingDirectory : string

Disk caching directory.

Type

string

$shouldCloseFile

$shouldCloseFile : bool

Type

bool

$spreadsheet

$spreadsheet : \PhpOffice\PhpSpreadsheet\Spreadsheet

PhpSpreadsheet object.

Type

Spreadsheet

$strTotal

$strTotal : int

Total number of shared strings in workbook.

Type

int

$strUnique

$strUnique : int

Number of unique shared strings in workbook.

Type

int

$strTable

$strTable : array

Array of unique shared strings in workbook.

Type

array

$colors

$colors : array

Color cache. Mapping between RGB value and color index.

Type

array

$parser

$parser : \PhpOffice\PhpSpreadsheet\Writer\Xls\Parser

Formula parser.

Type

Parser

$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

$writerWorkbook

$writerWorkbook : \PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook

Type

Workbook

$writerWorksheets

$writerWorksheets : \PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet[]

Type

Worksheet[]

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 PhpSpreadsheet object.

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

Returns

bool —

setIncludeCharts()

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

mixed $pValue

Returns

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

Returns

bool —

setPreCalculateFormulas()

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

mixed $pValue

Pre-Calculate Formulas?

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter —

getUseDiskCaching()

getUseDiskCaching() : bool

Get use disk caching where possible?

Returns

bool —

setUseDiskCaching()

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

Set use disk caching where possible?

Parameters

mixed $pValue
mixed $pDirectory

Disk caching directory

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter —

getDiskCachingDirectory()

getDiskCachingDirectory() : string

Get disk caching directory.

Returns

string —

openFileHandle()

openFileHandle(resource|string  $filename) : void

Open file handle.

Parameters

resource|string $filename

__construct()

__construct(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet) : mixed

Create a new Xls Writer.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

PhpSpreadsheet object

Returns

mixed —

save()

save(resource|string  $pFilename) : void

Save Spreadsheet to file.

Parameters

resource|string $pFilename

maybeCloseFileHandle()

maybeCloseFileHandle() : void

Close file handle only if we opened it ourselves.

buildWorksheetEschers()

buildWorksheetEschers() : void

Build the Worksheet Escher objects.

processMemoryDrawing()

processMemoryDrawing(\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer  $bstoreContainer, \PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing  $drawing, string  $renderingFunctionx) : void

Parameters

\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer $bstoreContainer
\PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing $drawing
string $renderingFunctionx

processDrawing()

processDrawing(\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer  $bstoreContainer, \PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing  $drawing) : void

Parameters

\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer $bstoreContainer
\PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing $drawing

processBaseDrawing()

processBaseDrawing(\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer  $bstoreContainer, \PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing  $drawing) : void

Parameters

\PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer $bstoreContainer
\PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing $drawing

checkForDrawings()

checkForDrawings() : bool

Returns

bool —

buildWorkbookEscher()

buildWorkbookEscher() : void

Build the Escher object corresponding to the MSODRAWINGGROUP record.

writeDocumentSummaryInformation()

writeDocumentSummaryInformation() : string

Build the OLE Part for DocumentSummary Information.

Returns

string —

writeSummaryPropOle()

writeSummaryPropOle(int  $dataProp, int  $dataSection_NumProps, array  $dataSection, int  $sumdata, int  $typdata) : void

Parameters

int $dataProp
int $dataSection_NumProps
array $dataSection
int $sumdata
int $typdata

writeSummaryProp()

writeSummaryProp(string  $dataProp, int  $dataSection_NumProps, array  $dataSection, int  $sumdata, int  $typdata) : void

Parameters

string $dataProp
int $dataSection_NumProps
array $dataSection
int $sumdata
int $typdata

writeSummaryInformation()

writeSummaryInformation() : string

Build the OLE Part for Summary Information.

Returns

string —