PhpOffice\PhpSpreadsheet\Writer\Ods Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Writer\Ods:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Writer\Ods:

Public Member Functions
	__construct (Spreadsheet $spreadsheet)
	Create a new Ods. More...
	getWriterPartContent ()
	getWriterPartMeta ()
	getWriterPartMetaInf ()
	getWriterPartMimetype ()
	getWriterPartSettings ()
	getWriterPartStyles ()
	getWriterPartThumbnails ()
	save ($pFilename)
	Save PhpSpreadsheet to file. More...
	getSpreadsheet ()
	Get Spreadsheet object. More...
	setSpreadsheet (Spreadsheet $spreadsheet)
	Set Spreadsheet object. 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...

Private Member Functions
	createZip ()
	Create zip object. More...

Private Attributes
	$spreadSheet
	$writerPartContent
	$writerPartMeta
	$writerPartMetaInf
	$writerPartMimetype
	$writerPartSettings
	$writerPartStyles
	$writerPartThumbnails

Additional Inherited Members
Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter
	maybeCloseFileHandle ()
	Close file handle only if we opened it ourselves. More...
Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter
	$includeCharts = false
	$preCalculateFormulas = true
	$fileHandle

Detailed Description

Definition at line 18 of file Ods.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Writer\Ods::__construct

(

Spreadsheet

$spreadsheet

)

Create a new Ods.

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 65 of file Ods.php.

References PhpOffice\PhpSpreadsheet\Writer\Ods\setSpreadsheet().

    {
        $this->setSpreadsheet($spreadsheet);

        $this->writerPartContent = new Content($this);
        $this->writerPartMeta = new Meta($this);
        $this->writerPartMetaInf = new MetaInf($this);
        $this->writerPartMimetype = new Mimetype($this);
        $this->writerPartSettings = new Settings($this);
        $this->writerPartStyles = new Styles($this);
        $this->writerPartThumbnails = new Thumbnails($this);
    }

Here is the call graph for this function:

Member Function Documentation

createZip()

PhpOffice\PhpSpreadsheet\Writer\Ods::createZip ( )

private

Create zip object.

Returns

ZipStream

Definition at line 154 of file Ods.php.

References PHPMailer\PHPMailer\$options.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\save().

    {
        // Try opening the ZIP file
        if (!is_resource($this->fileHandle)) {
            throw new WriterException('Could not open resource for writing.');
        }

        // Create new ZIP stream
        $options = new Archive();
        $options->setEnableZip64(false);
        $options->setOutputStream($this->fileHandle);

        return new ZipStream(null, $options);
    }

Here is the caller graph for this function:

getSpreadsheet()

PhpOffice\PhpSpreadsheet\Writer\Ods::getSpreadsheet

(

)

Get Spreadsheet object.

Returns

Spreadsheet

Definition at line 174 of file Ods.php.

References PhpOffice\PhpSpreadsheet\Writer\Ods\$spreadSheet.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\Content\__construct(), and PhpOffice\PhpSpreadsheet\Writer\Ods\Content\write().

    {
        if ($this->spreadSheet !== null) {
            return $this->spreadSheet;
        }

        throw new WriterException('No PhpSpreadsheet assigned.');
    }

Here is the caller graph for this function:

getWriterPartContent()

PhpOffice\PhpSpreadsheet\Writer\Ods::getWriterPartContent

(

)

Definition at line 78 of file Ods.php.

References PhpOffice\PhpSpreadsheet\Writer\Ods\$writerPartContent.

                                          : Content
    {
        return $this->writerPartContent;
    }

getWriterPartMeta()

PhpOffice\PhpSpreadsheet\Writer\Ods::getWriterPartMeta

(

)

Definition at line 83 of file Ods.php.

References PhpOffice\PhpSpreadsheet\Writer\Ods\$writerPartMeta.

                                       : Meta
    {
        return $this->writerPartMeta;
    }

getWriterPartMetaInf()

PhpOffice\PhpSpreadsheet\Writer\Ods::getWriterPartMetaInf

(

)

Definition at line 88 of file Ods.php.

References PhpOffice\PhpSpreadsheet\Writer\Ods\$writerPartMetaInf.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\save().

                                          : MetaInf
    {
        return $this->writerPartMetaInf;
    }

Here is the caller graph for this function:

getWriterPartMimetype()

PhpOffice\PhpSpreadsheet\Writer\Ods::getWriterPartMimetype

(

)

Definition at line 93 of file Ods.php.

References PhpOffice\PhpSpreadsheet\Writer\Ods\$writerPartMimetype.

                                           : Mimetype
    {
        return $this->writerPartMimetype;
    }

getWriterPartSettings()

PhpOffice\PhpSpreadsheet\Writer\Ods::getWriterPartSettings

(

)

Definition at line 98 of file Ods.php.

References PhpOffice\PhpSpreadsheet\Writer\Ods\$writerPartSettings.

                                           : Settings
    {
        return $this->writerPartSettings;
    }

getWriterPartStyles()

PhpOffice\PhpSpreadsheet\Writer\Ods::getWriterPartStyles

(

)

Definition at line 103 of file Ods.php.

References PhpOffice\PhpSpreadsheet\Writer\Ods\$writerPartStyles.

                                         : Styles
    {
        return $this->writerPartStyles;
    }

getWriterPartThumbnails()

PhpOffice\PhpSpreadsheet\Writer\Ods::getWriterPartThumbnails

(

)

Definition at line 108 of file Ods.php.

References PhpOffice\PhpSpreadsheet\Writer\Ods\$writerPartThumbnails.

                                             : Thumbnails
    {
        return $this->writerPartThumbnails;
    }

save()

PhpOffice\PhpSpreadsheet\Writer\Ods::save

(

$pFilename

)

Save PhpSpreadsheet to file.

Parameters

resource | string

$pFilename

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 118 of file Ods.php.

References PhpOffice\PhpSpreadsheet\Writer\Ods\createZip(), PhpOffice\PhpSpreadsheet\Writer\Ods\getWriterPartMetaInf(), PhpOffice\PhpSpreadsheet\Writer\BaseWriter\maybeCloseFileHandle(), PhpOffice\PhpSpreadsheet\Writer\BaseWriter\openFileHandle(), and Sabre\VObject\write().

                                    : void
    {
        if (!$this->spreadSheet) {
            throw new WriterException('PhpSpreadsheet object unassigned.');
        }

        // garbage collect
        $this->spreadSheet->garbageCollect();

        $this->openFileHandle($pFilename);

        $zip = $this->createZip();

        $zip->addFile('META-INF/manifest.xml', $this->getWriterPartMetaInf()->write());
        $zip->addFile('Thumbnails/thumbnail.png', $this->getWriterPartthumbnails()->write());
        $zip->addFile('content.xml', $this->getWriterPartcontent()->write());
        $zip->addFile('meta.xml', $this->getWriterPartmeta()->write());
        $zip->addFile('mimetype', $this->getWriterPartmimetype()->write());
        $zip->addFile('settings.xml', $this->getWriterPartsettings()->write());
        $zip->addFile('styles.xml', $this->getWriterPartstyles()->write());

        // Close file
        try {
            $zip->finish();
        } catch (OverflowException $e) {
            throw new WriterException('Could not close resource.');
        }

        $this->maybeCloseFileHandle();
    }

Here is the call graph for this function:

setSpreadsheet()

PhpOffice\PhpSpreadsheet\Writer\Ods::setSpreadsheet

(

Spreadsheet

$spreadsheet

)

Set Spreadsheet object.

Parameters

Spreadsheet

$spreadsheet

PhpSpreadsheet object

Returns

$this

Definition at line 190 of file Ods.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\__construct().

    {
        $this->spreadSheet = $spreadsheet;

        return $this;
    }

Here is the caller graph for this function:

Field Documentation

$spreadSheet

PhpOffice\PhpSpreadsheet\Writer\Ods::$spreadSheet

private

Definition at line 25 of file Ods.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\getSpreadsheet().

$writerPartContent

PhpOffice\PhpSpreadsheet\Writer\Ods::$writerPartContent

private

Definition at line 30 of file Ods.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\getWriterPartContent().

$writerPartMeta

PhpOffice\PhpSpreadsheet\Writer\Ods::$writerPartMeta

private

Definition at line 35 of file Ods.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\getWriterPartMeta().

$writerPartMetaInf

PhpOffice\PhpSpreadsheet\Writer\Ods::$writerPartMetaInf

private

Definition at line 40 of file Ods.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\getWriterPartMetaInf().

$writerPartMimetype

PhpOffice\PhpSpreadsheet\Writer\Ods::$writerPartMimetype

private

Definition at line 45 of file Ods.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\getWriterPartMimetype().

$writerPartSettings

PhpOffice\PhpSpreadsheet\Writer\Ods::$writerPartSettings

private

Definition at line 50 of file Ods.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\getWriterPartSettings().

$writerPartStyles

PhpOffice\PhpSpreadsheet\Writer\Ods::$writerPartStyles

private

Definition at line 55 of file Ods.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\getWriterPartStyles().

$writerPartThumbnails

PhpOffice\PhpSpreadsheet\Writer\Ods::$writerPartThumbnails

private

Definition at line 60 of file Ods.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Ods\getWriterPartThumbnails().

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Writer/Ods.php