class PHPExcel_Writer_OpenDocument extends PHPExcel_Writer_Abstract implements PHPExcel_Writer_IWriter

PHPExcelWriterOpenDocument

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

Methods

boolean
getIncludeCharts()

Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PHPExcel object.

setIncludeCharts(boolean $pValue = false)

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

boolean
getPreCalculateFormulas()

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

setPreCalculateFormulas(boolean $pValue = true)

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.

boolean
getUseDiskCaching()

Get use disk caching where possible?

setUseDiskCaching(boolean $pValue = false, string $pDirectory = null)

Set use disk caching where possible?

string
getDiskCachingDirectory()

Get disk caching directory

__construct(PHPExcel $pPHPExcel = null)

Create a new PHPExcelWriterOpenDocument

getWriterPart(string $pPartName = '')

Get writer part

save($pFilename = null)

Save PHPExcel to file

getPHPExcel()

Get PHPExcel object

setPHPExcel(PHPExcel $pPHPExcel = null)

Set PHPExcel object

Details

boolean getIncludeCharts()

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.

Return Value

boolean

PHPExcel_Writer_IWriter setIncludeCharts(boolean $pValue = false)

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

Return Value

PHPExcel_Writer_IWriter

boolean getPreCalculateFormulas()

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

Return Value

boolean

PHPExcel_Writer_IWriter setPreCalculateFormulas(boolean $pValue = true)

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?

Return Value

PHPExcel_Writer_IWriter

boolean getUseDiskCaching()

Get use disk caching where possible?

Return Value

boolean

PHPExcel_Writer_Excel2007 setUseDiskCaching(boolean $pValue = false, string $pDirectory = null)

Set use disk caching where possible?

Parameters

boolean $pValue
string $pDirectory Disk caching directory

Return Value

PHPExcel_Writer_Excel2007

Exceptions

PHPExcel_Writer_Exception when directory does not exist

string getDiskCachingDirectory()

Get disk caching directory

Return Value

string

at line 58
__construct(PHPExcel $pPHPExcel = null)

Create a new PHPExcelWriterOpenDocument

Parameters

PHPExcel $pPHPExcel

at line 83
PHPExcel_Writer_Excel2007_WriterPart getWriterPart(string $pPartName = '')

Get writer part

Parameters

string $pPartName Writer part name

Return Value

PHPExcel_Writer_Excel2007_WriterPart

at line 98
save($pFilename = null)

Save PHPExcel to file

Parameters

$pFilename

Exceptions

PHPExcel_Writer_Exception

at line 178
PHPExcel getPHPExcel()

Get PHPExcel object

Return Value

PHPExcel

Exceptions

PHPExcel_Writer_Exception

at line 194
PHPExcel_Writer_Excel2007 setPHPExcel(PHPExcel $pPHPExcel = null)

Set PHPExcel object

Parameters

PHPExcel $pPHPExcel PHPExcel object

Return Value

PHPExcel_Writer_Excel2007

Exceptions

PHPExcel_Writer_Exception