\PHPExcel_Writer_Excel5

PHPExcel_Writer_Excel5

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
getIncludeCharts()
setIncludeCharts()
getPreCalculateFormulas()
setPreCalculateFormulas()
getUseDiskCaching()
setUseDiskCaching()
getDiskCachingDirectory()
__construct()
save()
setTempDir()
No public properties found
No constants found
No protected methods found
$includeCharts
$preCalculateFormulas
$_useDiskCaching
$_diskCachingDirectory
N/A
buildWorksheetEschers()
buildWorkbookEscher()
writeDocumentSummaryInformation()
writeSummaryInformation()
$phpExcel
$strTotal
$strUnique
$strTable
$colors
$parser
$IDCLs
$summaryInformation
$documentSummaryInformation
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 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

$strTotal

$strTotal : integer

Total number of shared strings in workbook

Type

integer

$strUnique

$strUnique : integer

Number of unique shared strings in workbook

Type

integer

$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

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

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

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

Build the Worksheet Escher objects

buildWorkbookEscher()

buildWorkbookEscher() 

Build the Escher object corresponding to the MSODRAWINGGROUP record

writeDocumentSummaryInformation()

writeDocumentSummaryInformation() : string

Build the OLE Part for DocumentSummary Information

Returns

string

writeSummaryInformation()

writeSummaryInformation() : string

Build the OLE Part for Summary Information

Returns

string