Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/phpspreadsheet/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Writer/ -> IWriter.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]

(no description)

File Size: 93 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

IWriter:: (9 methods):
  __construct()
  getIncludeCharts()
  setIncludeCharts()
  getPreCalculateFormulas()
  setPreCalculateFormulas()
  save()
  getUseDiskCaching()
  setUseDiskCaching()
  getDiskCachingDirectory()


Interface: IWriter  - X-Ref

__construct(Spreadsheet $spreadsheet)   X-Ref
IWriter constructor.

param: Spreadsheet $spreadsheet The spreadsheet that we want to save using this Writer

getIncludeCharts()   X-Ref
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.

return: bool

setIncludeCharts($includeCharts)   X-Ref
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.

param: bool $includeCharts
return: IWriter

getPreCalculateFormulas()   X-Ref
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.

return: bool

setPreCalculateFormulas($precalculateFormulas)   X-Ref
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.

param: bool $precalculateFormulas Pre-Calculate Formulas?
return: IWriter

save($filename, int $flags = 0)   X-Ref
Save PhpSpreadsheet to file.

param: resource|string $filename Name of the file to save

getUseDiskCaching()   X-Ref
Get use disk caching where possible?

return: bool

setUseDiskCaching($useDiskCache, $cacheDirectory = null)   X-Ref
Set use disk caching where possible?

param: bool $useDiskCache
param: string $cacheDirectory Disk caching directory
return: IWriter

getDiskCachingDirectory()   X-Ref
Get disk caching directory.

return: string