PHPExcel_Writer_OpenDocument Class Reference

Inheritance diagram for PHPExcel_Writer_OpenDocument:

Collaboration diagram for PHPExcel_Writer_OpenDocument:

Public Member Functions
	__construct (PHPExcel $pPHPExcel=null)
	Create a new PHPExcel_Writer_OpenDocument. More...
	getWriterPart ($pPartName='')
	Get writer part. More...
	save ($pFilename=NULL)
	Save PHPExcel to file. More...
	getPHPExcel ()
	Get PHPExcel object. More...
	setPHPExcel (PHPExcel $pPHPExcel=null)
	Set PHPExcel object. 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...
	save ($pFilename=NULL)
	Save PHPExcel to file. More...

Private Member Functions
	_createZip ($pFilename)
	Create zip object. More...

Private Attributes
	$_writerParts = array()
	$_spreadSheet

Additional Inherited Members
Protected Attributes inherited from PHPExcel_Writer_Abstract
	$_includeCharts = FALSE
	$_preCalculateFormulas = TRUE
	$_useDiskCaching = FALSE
	$_diskCachingDirectory = './'

Detailed Description

Definition at line 38 of file OpenDocument.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Writer_OpenDocument::__construct

(

PHPExcel

$pPHPExcel = null

)

Create a new PHPExcel_Writer_OpenDocument.

Parameters

PHPExcel

$pPHPExcel

Definition at line 59 of file OpenDocument.php.

    {
        $this->setPHPExcel($pPHPExcel);
 
        $writerPartsArray = array(
            'content'    => 'PHPExcel_Writer_OpenDocument_Content',
            'meta'       => 'PHPExcel_Writer_OpenDocument_Meta',
            'meta_inf'   => 'PHPExcel_Writer_OpenDocument_MetaInf',
            'mimetype'   => 'PHPExcel_Writer_OpenDocument_Mimetype',
            'settings'   => 'PHPExcel_Writer_OpenDocument_Settings',
            'styles'     => 'PHPExcel_Writer_OpenDocument_Styles',
            'thumbnails' => 'PHPExcel_Writer_OpenDocument_Thumbnails'
        );
 
        foreach ($writerPartsArray as $writer => $class) {
            $this->_writerParts[$writer] = new $class($this);
        }
    }

References setPHPExcel().

Here is the call graph for this function:

Member Function Documentation

_createZip()

PHPExcel_Writer_OpenDocument::_createZip (   $pFilename )

private

Create zip object.

Parameters

string

$pFilename

Exceptions

PHPExcel_Writer_Exception

Returns

ZipArchive

Definition at line 148 of file OpenDocument.php.

    {
        // Create new ZIP file and open it for writing
        $zipClass = PHPExcel_Settings::getZipClass();
        $objZip = new $zipClass();
 
        // Retrieve OVERWRITE and CREATE constants from the instantiated zip class
        // This method of accessing constant values from a dynamic class should work with all appropriate versions of PHP
        $ro = new ReflectionObject($objZip);
        $zipOverWrite = $ro->getConstant('OVERWRITE');
        $zipCreate = $ro->getConstant('CREATE');
 
        if (file_exists($pFilename)) {
            unlink($pFilename);
        }
        // Try opening the ZIP file
        if ($objZip->open($pFilename, $zipOverWrite) !== true) {
            if ($objZip->open($pFilename, $zipCreate) !== true) {
                throw new PHPExcel_Writer_Exception("Could not open $pFilename for writing.");
            }
        }
 
        return $objZip;
    }

References PHPExcel_Settings\getZipClass().

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

getPHPExcel()

PHPExcel_Writer_OpenDocument::getPHPExcel

(

)

Get PHPExcel object.

Returns

PHPExcel

Exceptions

PHPExcel_Writer_Exception

Definition at line 179 of file OpenDocument.php.

    {
        if ($this->_spreadSheet !== null) {
            return $this->_spreadSheet;
        } else {
            throw new PHPExcel_Writer_Exception('No PHPExcel assigned.');
        }
    }

References $_spreadSheet.

getWriterPart()

PHPExcel_Writer_OpenDocument::getWriterPart

(

$pPartName = ''

)

Get writer part.

Parameters

string

$pPartName

Writer part name

Returns

PHPExcel_Writer_Excel2007_WriterPart

Definition at line 84 of file OpenDocument.php.

    {
        if ($pPartName != '' && isset($this->_writerParts[strtolower($pPartName)])) {
            return $this->_writerParts[strtolower($pPartName)];
        } else {
            return null;
        }
    }

Referenced by save().

Here is the caller graph for this function:

save()

PHPExcel_Writer_OpenDocument::save

(

$pFilename = NULL

)

Save PHPExcel to file.

Parameters

string

$pFilename

Exceptions

PHPExcel_Writer_Exception

Implements PHPExcel_Writer_IWriter.

Definition at line 99 of file OpenDocument.php.

    {
        if (!$this->_spreadSheet) {
            throw new PHPExcel_Writer_Exception('PHPExcel object unassigned.');
        }
 
        // garbage collect
        $this->_spreadSheet->garbageCollect();
 
        // If $pFilename is php://output or php://stdout, make it a temporary file...
        $originalFilename = $pFilename;
        if (strtolower($pFilename) == 'php://output' || strtolower($pFilename) == 'php://stdout') {
            $pFilename = @tempnam(PHPExcel_Shared_File::sys_get_temp_dir(), 'phpxltmp');
            if ($pFilename == '') {
                $pFilename = $originalFilename;
            }
        }
 
        $objZip = $this->_createZip($pFilename);
 
        $objZip->addFromString('META-INF/manifest.xml', $this->getWriterPart('meta_inf')->writeManifest());
        $objZip->addFromString('Thumbnails/thumbnail.png', $this->getWriterPart('thumbnails')->writeThumbnail());
        $objZip->addFromString('content.xml',  $this->getWriterPart('content')->write());
        $objZip->addFromString('meta.xml',     $this->getWriterPart('meta')->write());
        $objZip->addFromString('mimetype',     $this->getWriterPart('mimetype')->write());
        $objZip->addFromString('settings.xml', $this->getWriterPart('settings')->write());
        $objZip->addFromString('styles.xml',   $this->getWriterPart('styles')->write());
 
        // Close file
        if ($objZip->close() === false) {
            throw new PHPExcel_Writer_Exception("Could not close zip file $pFilename.");
        }
 
        // If a temporary file was used, copy it to the correct file stream
        if ($originalFilename != $pFilename) {
            if (copy($pFilename, $originalFilename) === false) {
                throw new PHPExcel_Writer_Exception("Could not copy temporary zip file $pFilename to $originalFilename.");
            }
            @unlink($pFilename);
        }
    }

References _createZip(), getWriterPart(), and PHPExcel_Shared_File\sys_get_temp_dir().

Here is the call graph for this function:

setPHPExcel()

PHPExcel_Writer_OpenDocument::setPHPExcel

(

PHPExcel

$pPHPExcel = null

)

Set PHPExcel object.

Parameters

PHPExcel

$pPHPExcel

PHPExcel object

Exceptions

PHPExcel_Writer_Exception

Returns

PHPExcel_Writer_Excel2007

Definition at line 195 of file OpenDocument.php.

    {
        $this->_spreadSheet = $pPHPExcel;
        return $this;
    }

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$_spreadSheet

PHPExcel_Writer_OpenDocument::$_spreadSheet

private

Definition at line 52 of file OpenDocument.php.

Referenced by getPHPExcel().

$_writerParts

PHPExcel_Writer_OpenDocument::$_writerParts = array()

private

Definition at line 45 of file OpenDocument.php.

---

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

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