PHPExcel_Writer_PDF_mPDF Class Reference

Inheritance diagram for PHPExcel_Writer_PDF_mPDF:

Collaboration diagram for PHPExcel_Writer_PDF_mPDF:

Public Member Functions
	__construct (PHPExcel $phpExcel)
	Create a new PHPExcel_Writer_PDF. More...
	save ($pFilename=NULL)
	Save PHPExcel to file. More...
Public Member Functions inherited from PHPExcel_Writer_PDF_Core
	__construct (PHPExcel $phpExcel)
	Create a new PHPExcel_Writer_PDF. More...
	getFont ()
	Get Font. More...
	setFont ($fontName)
	Set font. More...
	getPaperSize ()
	Get Paper Size. More...
	setPaperSize ($pValue=PHPExcel_Worksheet_PageSetup::PAPERSIZE_LETTER)
	Set Paper Size. More...
	getOrientation ()
	Get Orientation. More...
	setOrientation ($pValue=PHPExcel_Worksheet_PageSetup::ORIENTATION_DEFAULT)
	Set Orientation. More...
	getTempDir ()
	Get temporary storage directory. More...
	setTempDir ($pValue='')
	Set temporary storage directory. More...
Public Member Functions inherited from PHPExcel_Writer_HTML
	__construct (PHPExcel $phpExcel)
	Create a new PHPExcel_Writer_HTML. More...
	save ($pFilename=null)
	Save PHPExcel to file. More...
	getSheetIndex ()
	Get sheet index. More...
	setSheetIndex ($pValue=0)
	Set sheet index. More...
	getGenerateSheetNavigationBlock ()
	Get sheet index. More...
	setGenerateSheetNavigationBlock ($pValue=true)
	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=false)
	Set use inline CSS? More...
	formatColor ($pValue, $pFormat)
	Add color to formatted string as inline style. More...
Public Member Functions inherited from PHPExcel_Writer_Abstract
	getIncludeCharts ()
	Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PHPExcel object. More...
	setIncludeCharts ($pValue=FALSE)
	Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PHPExcel 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=TRUE)
	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=FALSE, $pDirectory=NULL)
	Set use disk caching where possible? More...
	getDiskCachingDirectory ()
	Get disk caching directory. More...

Additional Inherited Members
Protected Member Functions inherited from PHPExcel_Writer_PDF_Core
	prepareForSave ($pFilename=NULL)
	Save PHPExcel to PDF file, pre-save. More...
	restoreStateAfterSave ($fileHandle)
	Save PHPExcel to PDF file, post-save. More...
Protected Attributes inherited from PHPExcel_Writer_PDF_Core
	$_tempDir = ''
	$_font = 'freesans'
	$_orientation = NULL
	$_paperSize = NULL
Protected Attributes inherited from PHPExcel_Writer_HTML
	$_phpExcel
	$_isPdf = false
Protected Attributes inherited from PHPExcel_Writer_Abstract
	$_includeCharts = FALSE
	$_preCalculateFormulas = TRUE
	$_useDiskCaching = FALSE
	$_diskCachingDirectory = './'
Static Protected Attributes inherited from PHPExcel_Writer_PDF_Core
static	$_paperSizes

Detailed Description

Definition at line 44 of file mPDF.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Writer_PDF_mPDF::__construct

(

PHPExcel

$phpExcel

)

Create a new PHPExcel_Writer_PDF.

Parameters

PHPExcel

$phpExcel

PHPExcel object

Definition at line 51 of file mPDF.php.

    {
        parent::__construct($phpExcel);
    }

Member Function Documentation

save()

PHPExcel_Writer_PDF_mPDF::save

(

$pFilename = NULL

)

Save PHPExcel to file.

Parameters

string

$pFilename

Name of the file to save as

Exceptions

PHPExcel_Writer_Exception

Implements PHPExcel_Writer_IWriter.

Definition at line 62 of file mPDF.php.

References $pdf, PHPExcel_Writer_HTML\generateHTMLFooter(), PHPExcel_Writer_HTML\generateHTMLHeader(), PHPExcel_Writer_HTML\generateSheetData(), PHPExcel_Writer_PDF_Core\getOrientation(), PHPExcel_Writer_PDF_Core\getPaperSize(), PHPExcel_Writer_HTML\getSheetIndex(), PHPExcel_Worksheet_PageSetup\ORIENTATION_DEFAULT, PHPExcel_Worksheet_PageSetup\ORIENTATION_LANDSCAPE, PHPExcel_Worksheet_PageSetup\ORIENTATION_PORTRAIT, and PHPExcel_Writer_PDF_Core\setOrientation().

    {
        $fileHandle = parent::prepareForSave($pFilename);

        //  Default PDF paper size
        $paperSize = 'LETTER';    //    Letter    (8.5 in. by 11 in.)

        //  Check for paper size and page orientation
        if (is_null($this->getSheetIndex())) {
            $orientation = ($this->_phpExcel->getSheet(0)->getPageSetup()->getOrientation()
                == PHPExcel_Worksheet_PageSetup::ORIENTATION_LANDSCAPE)
                    ? 'L'
                    : 'P';
            $printPaperSize = $this->_phpExcel->getSheet(0)->getPageSetup()->getPaperSize();
            $printMargins = $this->_phpExcel->getSheet(0)->getPageMargins();
        } else {
            $orientation = ($this->_phpExcel->getSheet($this->getSheetIndex())->getPageSetup()->getOrientation()
                == PHPExcel_Worksheet_PageSetup::ORIENTATION_LANDSCAPE)
                    ? 'L'
                    : 'P';
            $printPaperSize = $this->_phpExcel->getSheet($this->getSheetIndex())->getPageSetup()->getPaperSize();
            $printMargins = $this->_phpExcel->getSheet($this->getSheetIndex())->getPageMargins();
        }
        $this->setOrientation($orientation);

        //  Override Page Orientation
        if (!is_null($this->getOrientation())) {
            $orientation = ($this->getOrientation() == PHPExcel_Worksheet_PageSetup::ORIENTATION_DEFAULT)
                ? PHPExcel_Worksheet_PageSetup::ORIENTATION_PORTRAIT
                : $this->getOrientation();
        }
        $orientation = strtoupper($orientation);

        //  Override Paper Size
        if (!is_null($this->getPaperSize())) {
            $printPaperSize = $this->getPaperSize();
        }

        if (isset(self::$_paperSizes[$printPaperSize])) {
            $paperSize = self::$_paperSizes[$printPaperSize];
        }

        //  Create PDF
        $pdf = new mpdf();
        $ortmp = $orientation;
        $pdf->_setPageSize(strtoupper($paperSize), $ortmp);
        $pdf->DefOrientation = $orientation;
        $pdf->AddPage($orientation);

        //  Document info
        $pdf->SetTitle($this->_phpExcel->getProperties()->getTitle());
        $pdf->SetAuthor($this->_phpExcel->getProperties()->getCreator());
        $pdf->SetSubject($this->_phpExcel->getProperties()->getSubject());
        $pdf->SetKeywords($this->_phpExcel->getProperties()->getKeywords());
        $pdf->SetCreator($this->_phpExcel->getProperties()->getCreator());

        $pdf->WriteHTML(
            $this->generateHTMLHeader(FALSE) .
            $this->generateSheetData() .
            $this->generateHTMLFooter()
        );

        //  Write to file
        fwrite($fileHandle, $pdf->Output('', 'S'));

                parent::restoreStateAfterSave($fileHandle);
    }

Here is the call graph for this function:

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Writer/PDF/mPDF.php