Inheritance diagram for PhpOffice\PhpSpreadsheet\Writer\BaseWriter:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Writer\BaseWriter:

Public Member Functions
	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...

	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...

	openFileHandle ($filename)
	Open file handle. More...

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\IWriter
	__construct (Spreadsheet $spreadsheet)
	IWriter constructor. More...

	save ($pFilename)
	Save PhpSpreadsheet to file. More...

Protected Member Functions
	maybeCloseFileHandle ()
	Close file handle only if we opened it ourselves. More...

Protected Attributes
	$includeCharts = false

	$preCalculateFormulas = true

	$fileHandle

Private Attributes
	$useDiskCaching = false

	$diskCachingDirectory = './'

	$shouldCloseFile

Detailed Description

Definition at line 5 of file BaseWriter.php.

Member Function Documentation

◆ getDiskCachingDirectory()

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

Get disk caching directory.

Returns: string

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 92 of file BaseWriter.php.

References PhpOffice\PhpSpreadsheet\Writer\BaseWriter\$diskCachingDirectory.

     {
         return $this->diskCachingDirectory;
     }

Here is the caller graph for this function:

◆ getIncludeCharts()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::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

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 48 of file BaseWriter.php.

References PhpOffice\PhpSpreadsheet\Writer\BaseWriter\$includeCharts.

     {
         return $this->includeCharts;
     }

◆ getPreCalculateFormulas()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::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

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 60 of file BaseWriter.php.

References PhpOffice\PhpSpreadsheet\Writer\BaseWriter\$preCalculateFormulas.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeCellFormula(), and PhpOffice\PhpSpreadsheet\Writer\Ods\Content\writeRows().

     {
         return $this->preCalculateFormulas;
     }

Here is the caller graph for this function:

◆ getUseDiskCaching()

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

Get use disk caching where possible?

Returns: bool

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 72 of file BaseWriter.php.

References PhpOffice\PhpSpreadsheet\Writer\BaseWriter\$useDiskCaching.

     {
         return $this->useDiskCaching;
     }

Here is the caller graph for this function:

◆ maybeCloseFileHandle()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::maybeCloseFileHandle ( )

protected

Close file handle only if we opened it ourselves.

Definition at line 123 of file BaseWriter.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\restoreStateAfterSave(), PhpOffice\PhpSpreadsheet\Writer\Csv\save(), PhpOffice\PhpSpreadsheet\Writer\Ods\save(), PhpOffice\PhpSpreadsheet\Writer\Xls\save(), PhpOffice\PhpSpreadsheet\Writer\Html\save(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\save().

                                              : void
     {
         if ($this->shouldCloseFile) {
             if (!fclose($this->fileHandle)) {
                 throw new Exception('Could not close file after writing.');
             }
         }
     }

Here is the caller graph for this function:

◆ openFileHandle()

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

Open file handle.

Parameters

resource | string $filename

Definition at line 102 of file BaseWriter.php.

References PhpOffice\PhpSpreadsheet\Writer\BaseWriter\$fileHandle, and $filename.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\prepareForSave(), PhpOffice\PhpSpreadsheet\Writer\Csv\save(), PhpOffice\PhpSpreadsheet\Writer\Ods\save(), PhpOffice\PhpSpreadsheet\Writer\Xls\save(), PhpOffice\PhpSpreadsheet\Writer\Html\save(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\save().

                                              : void
     {
         if (is_resource($filename)) {
             $this->fileHandle = $filename;
             $this->shouldCloseFile = false;
 
             return;
         }
 
         $fileHandle = $filename ? fopen($filename, 'wb+') : false;
         if ($fileHandle === false) {
             throw new Exception('Could not open file "' . $filename . '" for writing.');
         }
 
         $this->fileHandle = $fileHandle;
         $this->shouldCloseFile = true;
     }

Here is the caller graph for this function:

◆ setIncludeCharts()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::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

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 53 of file BaseWriter.php.

     {
         $this->includeCharts = (bool) $pValue;
 
         return $this;
     }

◆ setPreCalculateFormulas()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::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

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 65 of file BaseWriter.php.

     {
         $this->preCalculateFormulas = (bool) $pValue;
 
         return $this;
     }

◆ setUseDiskCaching()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::setUseDiskCaching	(	$pValue,
		$pDirectory = `null`
	)

Set use disk caching where possible?

Parameters

bool	$pValue
string	$pDirectory	Disk caching directory

Returns: IWriter

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 77 of file BaseWriter.php.

     {
         $this->useDiskCaching = $pValue;
 
         if ($pDirectory !== null) {
             if (is_dir($pDirectory)) {
                 $this->diskCachingDirectory = $pDirectory;
             } else {
                 throw new Exception("Directory does not exist: $pDirectory");
             }
         }
 
         return $this;
     }

Field Documentation

◆ $diskCachingDirectory

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::$diskCachingDirectory = './'

private

Definition at line 36 of file BaseWriter.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\BaseWriter\getDiskCachingDirectory().

◆ $fileHandle

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::$fileHandle

protected

Definition at line 41 of file BaseWriter.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\BaseWriter\openFileHandle(), PhpOffice\PhpSpreadsheet\Writer\Pdf\prepareForSave(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf\save(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf\save(), and PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf\save().

◆ $includeCharts

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::$includeCharts = false

protected

Definition at line 13 of file BaseWriter.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\BaseWriter\getIncludeCharts(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\save(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\ContentTypes\writeContentTypes(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeDrawings(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Rels\writeUnparsedRelationship(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeWorksheet(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Rels\writeWorksheetRelationships().

◆ $preCalculateFormulas

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::$preCalculateFormulas = true

protected

Definition at line 22 of file BaseWriter.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\BaseWriter\getPreCalculateFormulas().

◆ $shouldCloseFile

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::$shouldCloseFile

private

Definition at line 46 of file BaseWriter.php.

◆ $useDiskCaching

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::$useDiskCaching = false

private

Definition at line 29 of file BaseWriter.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\BaseWriter\getUseDiskCaching().

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Writer/BaseWriter.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ getDiskCachingDirectory()

◆ getIncludeCharts()

◆ getPreCalculateFormulas()

◆ getUseDiskCaching()

◆ maybeCloseFileHandle()

◆ openFileHandle()

◆ setIncludeCharts()

◆ setPreCalculateFormulas()

◆ setUseDiskCaching()

Field Documentation

◆ $diskCachingDirectory

◆ $fileHandle

◆ $includeCharts

◆ $preCalculateFormulas

◆ $shouldCloseFile

◆ $useDiskCaching