Inheritance diagram for PhpOffice\PhpSpreadsheet\Writer\Pdf:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Writer\Pdf:

Public Member Functions
	__construct (Spreadsheet $spreadsheet)
	Create a new PDF Writer instance. More...

	getFont ()
	Get Font. More...

	setFont ($fontName)
	Set font. More...

	getPaperSize ()
	Get Paper Size. More...

	setPaperSize ($pValue)
	Set Paper Size. More...

	getOrientation ()
	Get Orientation. More...

	setOrientation ($pValue)
	Set Orientation. More...

	getTempDir ()
	Get temporary storage directory. More...

	setTempDir ($pValue)
	Set temporary storage directory. More...

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\Html
	__construct (Spreadsheet $spreadsheet)
	Create a new HTML. More...

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

	generateHtmlAll ()
	Save Spreadsheet as html to variable. More...

	setEditHtmlCallback (?callable $callback)
	Set a callback to edit the entire HTML. More...

	getSheetIndex ()
	Get sheet index. More...

	setSheetIndex ($pValue)
	Set sheet index. More...

	getGenerateSheetNavigationBlock ()
	Get sheet index. More...

	setGenerateSheetNavigationBlock ($pValue)
	Set sheet index. More...

	writeAllSheets ()
	Write all sheets (resets sheetIndex to NULL). More...

	generateHTMLHeader ($pIncludeStyles=false)
	Generate HTML header. More...

	generateSheetData ()
	Generate sheet data. More...

	generateNavigation ()
	Generate sheet tabs. More...

	generateStyles ($generateSurroundingHTML=true)
	Generate CSS styles. More...

	buildCSS ($generateSurroundingHTML=true)
	Build CSS styles. More...

	generateHTMLFooter ()
	Generate HTML footer. More...

	getImagesRoot ()
	Get images root. More...

	setImagesRoot ($pValue)
	Set images root. More...

	getEmbedImages ()
	Get embed images. More...

	setEmbedImages ($pValue)
	Set embed images. More...

	getUseInlineCss ()
	Get use inline CSS? More...

	setUseInlineCss ($pValue)
	Set use inline CSS? More...

	getUseEmbeddedCSS ()
	Get use embedded CSS? More...

	setUseEmbeddedCSS ($pValue)
	Set use embedded CSS? More...

	formatColor ($pValue, $pFormat)
	Add color to formatted string as inline style. More...

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

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

Protected Member Functions
	prepareForSave ($pFilename)
	Save Spreadsheet to PDF file, pre-save. More...

	restoreStateAfterSave ()
	Save PhpSpreadsheet to PDF file, post-save. More...

Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter
	maybeCloseFileHandle ()
	Close file handle only if we opened it ourselves. More...

Protected Attributes
	$tempDir = ''

	$font = 'freesans'

	$orientation

	$paperSize

Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Writer\Html
	$spreadsheet

	$isPdf = false

Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter
	$includeCharts = false

	$preCalculateFormulas = true

	$fileHandle

Static Protected Attributes
static	$paperSizes

Additional Inherited Members
Static Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\Html
static	winFileToUrl ($filename)
	Convert Windows file name to file protocol URL. More...

Data Fields inherited from PhpOffice\PhpSpreadsheet\Writer\Html
const	VALIGN_ARR

const	HALIGN_ARR

const	BORDER_ARR

Detailed Description

Definition at line 10 of file Pdf.php.

Constructor & Destructor Documentation

◆ __construct()

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

Create a new PDF Writer instance.

Parameters

Spreadsheet $spreadsheet Spreadsheet object

Reimplemented from PhpOffice\PhpSpreadsheet\Writer\Html.

Reimplemented in PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf.

Definition at line 119 of file Pdf.php.

    {
        parent::__construct($spreadsheet);
        //$this->setUseInlineCss(true);
        $this->tempDir = File::sysGetTempDir() . '/phpsppdf';
        $this->isPdf = true;
    }

References PhpOffice\PhpSpreadsheet\Writer\Html\$spreadsheet, and PhpOffice\PhpSpreadsheet\Shared\File\sysGetTempDir().

Here is the call graph for this function:

Member Function Documentation

◆ getFont()

PhpOffice\PhpSpreadsheet\Writer\Pdf::getFont ( )

Get Font.

Returns: string

Definition at line 132 of file Pdf.php.

    {
        return $this->font;
    }

References PhpOffice\PhpSpreadsheet\Writer\Pdf\$font.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf\save().

Here is the caller graph for this function:

◆ getOrientation()

PhpOffice\PhpSpreadsheet\Writer\Pdf::getOrientation ( )

Get Orientation.

Returns: string

Definition at line 184 of file Pdf.php.

    {
        return $this->orientation;
    }

References PhpOffice\PhpSpreadsheet\Writer\Pdf\$orientation.

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

Here is the caller graph for this function:

◆ getPaperSize()

PhpOffice\PhpSpreadsheet\Writer\Pdf::getPaperSize ( )

Get Paper Size.

Returns: int

Definition at line 160 of file Pdf.php.

    {
        return $this->paperSize;
    }

References PhpOffice\PhpSpreadsheet\Writer\Pdf\$paperSize.

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

Here is the caller graph for this function:

◆ getTempDir()

PhpOffice\PhpSpreadsheet\Writer\Pdf::getTempDir ( )

Get temporary storage directory.

Returns: string

Definition at line 208 of file Pdf.php.

    {
        return $this->tempDir;
    }

References PhpOffice\PhpSpreadsheet\Writer\Pdf\$tempDir.

◆ prepareForSave()

PhpOffice\PhpSpreadsheet\Writer\Pdf::prepareForSave ( $pFilename )

protected

Save Spreadsheet to PDF file, pre-save.

Parameters

string $pFilename Name of the file to save as

Returns: resource

Definition at line 238 of file Pdf.php.

    {
        //  Open file
        $this->openFileHandle($pFilename);
 
        return $this->fileHandle;
    }

References PhpOffice\PhpSpreadsheet\Writer\BaseWriter\$fileHandle, and PhpOffice\PhpSpreadsheet\Writer\BaseWriter\openFileHandle().

Here is the call graph for this function:

◆ restoreStateAfterSave()

PhpOffice\PhpSpreadsheet\Writer\Pdf::restoreStateAfterSave ( )

protected

Save PhpSpreadsheet to PDF file, post-save.

Definition at line 249 of file Pdf.php.

                                              : void
    {
        $this->maybeCloseFileHandle();
    }

References PhpOffice\PhpSpreadsheet\Writer\BaseWriter\maybeCloseFileHandle().

Here is the call graph for this function:

◆ setFont()

PhpOffice\PhpSpreadsheet\Writer\Pdf::setFont ( $fontName )

Set font.

Examples: 'arialunicid0-chinese-simplified' 'arialunicid0-chinese-traditional' 'arialunicid0-korean' 'arialunicid0-japanese'.

Parameters

string $fontName

Returns: $this

Definition at line 148 of file Pdf.php.

    {
        $this->font = $fontName;
 
        return $this;
    }

◆ setOrientation()

PhpOffice\PhpSpreadsheet\Writer\Pdf::setOrientation ( $pValue )

Set Orientation.

Parameters

string $pValue Page orientation see PageSetup::ORIENTATION_*

Returns: self

Definition at line 196 of file Pdf.php.

    {
        $this->orientation = $pValue;
 
        return $this;
    }

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf\save().

Here is the caller graph for this function:

◆ setPaperSize()

PhpOffice\PhpSpreadsheet\Writer\Pdf::setPaperSize ( $pValue )

Set Paper Size.

Parameters

int $pValue Paper size see PageSetup::PAPERSIZE_*

Returns: self

Definition at line 172 of file Pdf.php.

    {
        $this->paperSize = $pValue;
 
        return $this;
    }

◆ setTempDir()

PhpOffice\PhpSpreadsheet\Writer\Pdf::setTempDir ( $pValue )

Set temporary storage directory.

Parameters

string $pValue Temporary storage directory

Returns: self

Definition at line 220 of file Pdf.php.

    {
        if (is_dir($pValue)) {
            $this->tempDir = $pValue;
        } else {
            throw new WriterException("Directory does not exist: $pValue");
        }
 
        return $this;
    }

Field Documentation

◆ $font

PhpOffice\PhpSpreadsheet\Writer\Pdf::$font = 'freesans'

protected

Definition at line 24 of file Pdf.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\getFont().

◆ $orientation

PhpOffice\PhpSpreadsheet\Writer\Pdf::$orientation

protected

Definition at line 31 of file Pdf.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf\createExternalWriterInstance(), PhpOffice\PhpSpreadsheet\Writer\Pdf\getOrientation(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf\save(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf\save(), and PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf\save().

◆ $paperSize

PhpOffice\PhpSpreadsheet\Writer\Pdf::$paperSize

protected

Definition at line 38 of file Pdf.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf\createExternalWriterInstance(), PhpOffice\PhpSpreadsheet\Writer\Pdf\getPaperSize(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf\save(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf\save(), and PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf\save().

◆ $paperSizes

PhpOffice\PhpSpreadsheet\Writer\Pdf::$paperSizes

staticprotected

Definition at line 45 of file Pdf.php.

◆ $tempDir

PhpOffice\PhpSpreadsheet\Writer\Pdf::$tempDir = ''

protected

Definition at line 17 of file Pdf.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\getTempDir().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getFont()

◆ getOrientation()

◆ getPaperSize()

◆ getTempDir()

◆ prepareForSave()

◆ restoreStateAfterSave()

◆ setFont()

◆ setOrientation()

◆ setPaperSize()

◆ setTempDir()

Field Documentation

◆ $font

◆ $orientation

◆ $paperSize

◆ $paperSizes

◆ $tempDir