Inheritance diagram for PhpOffice\PhpSpreadsheet\Writer\IWriter:
Collaboration diagram for PhpOffice\PhpSpreadsheet\Writer\IWriter:
Public Member Functions | |
| __construct (Spreadsheet $spreadsheet) | |
| IWriter constructor. More... | |
| getIncludeCharts () | |
| Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object. More... | |
| setIncludeCharts ($pValue) | |
| Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object. More... | |
| 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. More... | |
| setPreCalculateFormulas ($pValue) | |
| 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. More... | |
| save ($pFilename) | |
| Save PhpSpreadsheet to file. More... | |
| getUseDiskCaching () | |
| Get use disk caching where possible? More... | |
| setUseDiskCaching ($pValue, $pDirectory=null) | |
| Set use disk caching where possible? More... | |
| getDiskCachingDirectory () | |
| Get disk caching directory. More... | |
Detailed Description
Definition at line 7 of file IWriter.php.
Constructor & Destructor Documentation
◆ __construct()
| PhpOffice\PhpSpreadsheet\Writer\IWriter::__construct | ( | Spreadsheet | $spreadsheet | ) |
IWriter constructor.
Implemented in PhpOffice\PhpSpreadsheet\Writer\Xlsx, PhpOffice\PhpSpreadsheet\Writer\Html, PhpOffice\PhpSpreadsheet\Writer\Pdf, PhpOffice\PhpSpreadsheet\Writer\Xls, PhpOffice\PhpSpreadsheet\Writer\Csv, PhpOffice\PhpSpreadsheet\Writer\Ods, and PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf.
Member Function Documentation
◆ getDiskCachingDirectory()
| PhpOffice\PhpSpreadsheet\Writer\IWriter::getDiskCachingDirectory | ( | ) |
Get disk caching directory.
- Returns
- string
Implemented in PhpOffice\PhpSpreadsheet\Writer\BaseWriter.
◆ getIncludeCharts()
| PhpOffice\PhpSpreadsheet\Writer\IWriter::getIncludeCharts | ( | ) |
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
Implemented in PhpOffice\PhpSpreadsheet\Writer\BaseWriter.
◆ getPreCalculateFormulas()
| PhpOffice\PhpSpreadsheet\Writer\IWriter::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 PhpSpreadsheet, but slower when opening the resulting file in MS Excel, because Excel has to recalculate the formulae itself.
- Returns
- bool
Implemented in PhpOffice\PhpSpreadsheet\Writer\BaseWriter.
◆ getUseDiskCaching()
| PhpOffice\PhpSpreadsheet\Writer\IWriter::getUseDiskCaching | ( | ) |
Get use disk caching where possible?
- Returns
- bool
Implemented in PhpOffice\PhpSpreadsheet\Writer\BaseWriter.
◆ save()
| PhpOffice\PhpSpreadsheet\Writer\IWriter::save | ( | $pFilename | ) |
Save PhpSpreadsheet to file.
- Parameters
-
resource | string $pFilename Name of the file to save
Implemented in PhpOffice\PhpSpreadsheet\Writer\Xlsx, PhpOffice\PhpSpreadsheet\Writer\Html, PhpOffice\PhpSpreadsheet\Writer\Xls, PhpOffice\PhpSpreadsheet\Writer\Ods, PhpOffice\PhpSpreadsheet\Writer\Csv, PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf, PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf, and PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf.
◆ setIncludeCharts()
| PhpOffice\PhpSpreadsheet\Writer\IWriter::setIncludeCharts | ( | $pValue | ) |
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
-
bool $pValue
- Returns
- IWriter
Implemented in PhpOffice\PhpSpreadsheet\Writer\BaseWriter.
◆ setPreCalculateFormulas()
| PhpOffice\PhpSpreadsheet\Writer\IWriter::setPreCalculateFormulas | ( | $pValue | ) |
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 $pValue Pre-Calculate Formulas?
- Returns
- IWriter
Implemented in PhpOffice\PhpSpreadsheet\Writer\BaseWriter.
◆ setUseDiskCaching()
| PhpOffice\PhpSpreadsheet\Writer\IWriter::setUseDiskCaching | ( | $pValue, | |
$pDirectory = null |
|||
| ) |
Set use disk caching where possible?
- Parameters
-
bool $pValue string $pDirectory Disk caching directory
- Returns
- IWriter
Implemented in PhpOffice\PhpSpreadsheet\Writer\BaseWriter.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Writer/IWriter.php
