ODPresentation
extends AbstractWriter
in package
implements
WriterInterface
ODPresentation writer.
Table of Contents
Interfaces
- WriterInterface
- Writer interface.
Properties
- $chartArray : array<string|int, Chart>
- $oDrawingHashTable : HashTable
- Private unique hash table.
- $oPresentation : null|PhpPresentation
- Private PhpPresentation.
- $oZipAdapter : null|ZipInterface
- $diskCachingDirectory : string
- Disk caching directory.
- $useDiskCaching : bool
- Use disk caching where possible?
Methods
- __construct() : mixed
- Create a new \PhpOffice\PhpPresentation\Writer\ODPresentation.
- getDiskCachingDirectory() : string
- Get disk caching directory.
- getDrawingHashTable() : HashTable
- Get drawing hash table.
- getPhpPresentation() : PhpPresentation|null
- Get PhpPresentation object.
- getZipAdapter() : ZipInterface|null
- hasDiskCaching() : bool
- Get use disk caching where possible?
- save() : void
- Save PhpPresentation to file.
- setPhpPresentation() : self
- Get PhpPresentation object.
- setUseDiskCaching() : ODPresentation
- Set use disk caching where possible?
- setZipAdapter() : self
- allDrawings() : array<int, AbstractShape>
- Get an array of all drawings.
- iterateCollection() : array<int, AbstractShape>
Properties
$chartArray
public
array<string|int, Chart>
$chartArray
= []
$oDrawingHashTable
Private unique hash table.
protected
HashTable
$oDrawingHashTable
$oPresentation
Private PhpPresentation.
protected
null|PhpPresentation
$oPresentation
$oZipAdapter
protected
null|ZipInterface
$oZipAdapter
$diskCachingDirectory
Disk caching directory.
private
string
$diskCachingDirectory
$useDiskCaching
Use disk caching where possible?
private
bool
$useDiskCaching
= false
Methods
__construct()
Create a new \PhpOffice\PhpPresentation\Writer\ODPresentation.
public
__construct([PhpPresentation|null $pPhpPresentation = null ]) : mixed
Parameters
- $pPhpPresentation : PhpPresentation|null = null
getDiskCachingDirectory()
Get disk caching directory.
public
getDiskCachingDirectory() : string
Return values
stringgetDrawingHashTable()
Get drawing hash table.
public
getDrawingHashTable() : HashTable
Return values
HashTablegetPhpPresentation()
Get PhpPresentation object.
public
getPhpPresentation() : PhpPresentation|null
Return values
PhpPresentation|nullgetZipAdapter()
public
getZipAdapter() : ZipInterface|null
Return values
ZipInterface|nullhasDiskCaching()
Get use disk caching where possible?
public
hasDiskCaching() : bool
Return values
boolsave()
Save PhpPresentation to file.
public
save(string $pFilename) : void
Parameters
- $pFilename : string
setPhpPresentation()
Get PhpPresentation object.
public
setPhpPresentation([null|PhpPresentation $pPhpPresentation = null ]) : self
Parameters
- $pPhpPresentation : null|PhpPresentation = null
-
PhpPresentation object
Return values
selfsetUseDiskCaching()
Set use disk caching where possible?
public
setUseDiskCaching([bool $pValue = false ][, string $directory = null ]) : ODPresentation
Parameters
- $pValue : bool = false
- $directory : string = null
-
Disk caching directory
Return values
ODPresentationsetZipAdapter()
public
setZipAdapter(ZipInterface $oZipAdapter) : self
Parameters
- $oZipAdapter : ZipInterface
Return values
selfallDrawings()
Get an array of all drawings.
protected
allDrawings() : array<int, AbstractShape>
Return values
array<int, AbstractShape>iterateCollection()
private
iterateCollection(array<int, AbstractShape> $collection) : array<int, AbstractShape>
Parameters
- $collection : array<int, AbstractShape>