Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250711) (9addea9f0ac)
PhpOffice\PhpSpreadsheet\Writer\Xlsx Class Reference
Inheritance diagram for PhpOffice\PhpSpreadsheet\Writer\Xlsx:
PhpOffice\PhpSpreadsheet\Writer\BaseWriter PhpOffice\PhpSpreadsheet\Writer\IWriter

Public Member Functions

 __construct (Spreadsheet $spreadsheet)
 Create a new Xlsx Writer.
 
 getBordersHashTable ()
 Get Borders HashTable.
 
 getDiskCachingDirectory ()
 Get disk caching directory.
 
 getDrawingHashTable ()
 Get PhpOffice::PhpSpreadsheet::Worksheet::Worksheet::BaseDrawing HashTable.
 
 getExplicitStyle0 ()
 
 getFillHashTable ()
 Get Fill HashTable.
 
 getFontHashTable ()
 Get PhpOffice\PhpSpreadsheet\Style\Font HashTable.
 
 getIncludeCharts ()
 Write charts in workbook?
 
 getNumFmtHashTable ()
 Get NumberFormat HashTable.
 
 getOffice2003Compatibility ()
 Get Office2003 compatibility.
 
 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.
 
 getSpreadsheet ()
 Get Spreadsheet object.
 
 getStringTable ()
 Get string table.
 
 getStyleHashTable ()
 Get Style HashTable.
 
 getStylesConditionalHashTable ()
 Get Conditional HashTable.
 
 getUseDiskCaching ()
 Get use disk caching where possible?
 
 getWriterPartChart ()
 
 getWriterPartComments ()
 
 getWriterPartContentTypes ()
 
 getWriterPartDocProps ()
 
 getWriterPartDrawing ()
 
 getWriterPartRels ()
 
 getWriterPartRelsRibbon ()
 
 getWriterPartRelsVBA ()
 
 getWriterPartStringTable ()
 
 getWriterPartStyle ()
 
 getWriterPartTable ()
 
 getWriterPartTheme ()
 
 getWriterPartWorkbook ()
 
 getWriterPartWorksheet ()
 
 openFileHandle ($filename)
 Open file handle.
 
 save ($filename, int $flags=0)
 Save PhpSpreadsheet to file.
 
 setExplicitStyle0 (bool $explicitStyle0)
 This may be useful if non-default Alignment is part of default style and you think you might want to open the spreadsheet with LibreOffice or Gnumeric.
 
 setForceFullCalc (?bool $forceFullCalc)
 If this is set when a spreadsheet is opened, values may not be automatically re-calculated, and a button will be available to force re-calculation.
 
 setIncludeCharts (bool $includeCharts)
 Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object.
 
 setOffice2003Compatibility (bool $office2003compatibility)
 Set Office2003 compatibility.
 
 setPreCalculateFormulas (bool $precalculateFormulas)
 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.
 
 setSpreadsheet (Spreadsheet $spreadsheet)
 Set Spreadsheet object.
 
 setUseCSEArrays (?bool $useCSEArrays)
 
 setUseDiskCaching (bool $useDiskCache, ?string $cacheDirectory=null)
 Set use disk caching where possible?
 
 useDynamicArrays ()
 

Public Attributes

const DEFAULT_FORCE_FULL_CALC = false
 
const DISABLE_PRECALCULATE_FORMULAE = 2
 
const SAVE_WITH_CHARTS = 1
 

Protected Member Functions

 maybeCloseFileHandle ()
 Close file handle only if we opened it ourselves.
 
 processFlags (int $flags)
 

Protected Attributes

resource $fileHandle
 
bool $includeCharts = false
 
bool $preCalculateFormulas = true
 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.
 

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::__construct ( Spreadsheet $spreadsheet)

Create a new Xlsx Writer.

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Member Function Documentation

◆ getBordersHashTable()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::getBordersHashTable ( )

Get Borders HashTable.

Return values
HashTable<Borders>

◆ getDiskCachingDirectory()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::getDiskCachingDirectory ( )
inherited

Get disk caching directory.

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ getDrawingHashTable()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::getDrawingHashTable ( )

Get PhpOffice::PhpSpreadsheet::Worksheet::Worksheet::BaseDrawing HashTable.

Return values
HashTable<BaseDrawing>

◆ getFillHashTable()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::getFillHashTable ( )

Get Fill HashTable.

Return values
HashTable<Fill>

◆ getFontHashTable()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::getFontHashTable ( )

Get PhpOffice\PhpSpreadsheet\Style\Font HashTable.

Return values
HashTable<Font>

◆ getIncludeCharts()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::getIncludeCharts ( )
inherited

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.

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ getNumFmtHashTable()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::getNumFmtHashTable ( )

Get NumberFormat HashTable.

Return values
HashTable<NumberFormat>

◆ getPreCalculateFormulas()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::getPreCalculateFormulas ( )
inherited

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.

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ getStringTable()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::getStringTable ( )

Get string table.

Return values
string[]

◆ getStyleHashTable()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::getStyleHashTable ( )

Get Style HashTable.

Return values
HashTable<\PhpOffice\PhpSpreadsheet\Style\Style>

◆ getStylesConditionalHashTable()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::getStylesConditionalHashTable ( )

Get Conditional HashTable.

Return values
HashTable<Conditional>

◆ getUseDiskCaching()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::getUseDiskCaching ( )
inherited

Get use disk caching where possible?

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ openFileHandle()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::openFileHandle ( $filename)
inherited

Open file handle.

Parameters
resource | string$filename

◆ save()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::save ( $filename,
int $flags = 0 )

Save PhpSpreadsheet to file.

Parameters
resource | string$filename

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ setForceFullCalc()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::setForceFullCalc ( ?bool $forceFullCalc)

If this is set when a spreadsheet is opened, values may not be automatically re-calculated, and a button will be available to force re-calculation.

This may apply to all spreadsheets open at that time. If null, this will be set to the opposite of $preCalculateFormulas. It is likely that false is the desired setting, although cases have been reported where true is required (issue #456). Nevertheless, default is set to false in PhpSpreadsheet 4.0.0.

◆ setIncludeCharts()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::setIncludeCharts ( bool $includeCharts)
inherited

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.

Return values
$this

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ setOffice2003Compatibility()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::setOffice2003Compatibility ( bool $office2003compatibility)

Set Office2003 compatibility.

Parameters
bool$office2003compatibilityOffice2003 compatibility?
Return values
$this

◆ setPreCalculateFormulas()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::setPreCalculateFormulas ( bool $precalculateFormulas)
inherited

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$precalculateFormulasPre-Calculate Formulas?
Return values
$this

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ setSpreadsheet()

PhpOffice\PhpSpreadsheet\Writer\Xlsx::setSpreadsheet ( Spreadsheet $spreadsheet)

Set Spreadsheet object.

Parameters
Spreadsheet$spreadsheetPhpSpreadsheet object
Return values
$this

◆ setUseDiskCaching()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::setUseDiskCaching ( bool $useDiskCache,
?string $cacheDirectory = null )
inherited

Set use disk caching where possible?

Parameters
?string$cacheDirectoryDisk caching directory
Return values
$this

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.


The documentation for this class was generated from the following file: