WPS
extends AbstractWriter
in package
implements
WriterInterface
WPS writer, Microsoft Works word processor.
The document is an OLE compound file whose CONTENTS stream holds the chunked (CHNKWKS) representation of the document.
Tags
Table of Contents
Interfaces
- WriterInterface
- Writer interface.
Properties
- $mediaPaths : array<string|int, mixed>
- Paths to store media files.
- $parts : array<string|int, mixed>
- Part name and file name pairs.
- $phpWord : PhpWord
- PHPWord object.
- $writerParts : array<string|int, mixed>
- Individual writers.
Methods
- __construct() : mixed
- Create new instance.
- getDiskCachingDirectory() : string
- Get disk caching directory.
- getPhpWord() : PhpWord
- Get PhpWord object.
- getTempDir() : string
- Get temporary directory.
- getWriterPart() : mixed
- Get writer part.
- isUseDiskCaching() : bool
- Get use disk caching status.
- save() : void
- Save content to file.
- setPhpWord() : self
- Set PhpWord object.
- setTempDir() : self
- Set temporary directory.
- setUseDiskCaching() : self
- Set use disk caching status.
- addFilesToPackage() : void
- Add files to package.
- addFileToPackage() : void
- Add file to package.
- cleanupTempFile() : void
- Cleanup temporary file.
- clearTempDir() : void
- Clear temporary directory.
- getTempFile() : string
- Get temporary file name.
- getZipArchive() : ZipArchive
- Get ZipArchive object.
- openFile() : resource
- Open file for writing.
- writeFile() : void
- Write content to file.
Properties
$mediaPaths
Paths to store media files.
protected
array<string|int, mixed>
$mediaPaths
= ['image' => '', 'object' => '']
$parts
Part name and file name pairs.
protected
array<string|int, mixed>
$parts
= []
$phpWord
PHPWord object.
protected
PhpWord
$phpWord
$writerParts
Individual writers.
protected
array<string|int, mixed>
$writerParts
= []
Methods
__construct()
Create new instance.
public
__construct([PhpWord|null $phpWord = null ]) : mixed
Parameters
- $phpWord : PhpWord|null = null
getDiskCachingDirectory()
Get disk caching directory.
public
getDiskCachingDirectory() : string
Return values
stringgetPhpWord()
Get PhpWord object.
public
getPhpWord() : PhpWord
Return values
PhpWordgetTempDir()
Get temporary directory.
public
getTempDir() : string
Return values
stringgetWriterPart()
Get writer part.
public
getWriterPart([string $partName = '' ]) : mixed
Parameters
- $partName : string = ''
-
Writer part name
isUseDiskCaching()
Get use disk caching status.
public
isUseDiskCaching() : bool
Return values
boolsave()
Save content to file.
public
save(string $filename) : void
Parameters
- $filename : string
setPhpWord()
Set PhpWord object.
public
setPhpWord([PhpWord|null $phpWord = null ]) : self
Parameters
- $phpWord : PhpWord|null = null
Return values
selfsetTempDir()
Set temporary directory.
public
setTempDir(string $value) : self
Parameters
- $value : string
Return values
selfsetUseDiskCaching()
Set use disk caching status.
public
setUseDiskCaching([bool $value = false ][, string $directory = null ]) : self
Parameters
- $value : bool = false
- $directory : string = null
Return values
selfaddFilesToPackage()
Add files to package.
protected
addFilesToPackage(ZipArchive $zip, mixed $elements) : void
Parameters
- $zip : ZipArchive
- $elements : mixed
addFileToPackage()
Add file to package.
protected
addFileToPackage(ZipArchive $zipPackage, string $source, string $target) : void
Get the actual source from an archive image.
Parameters
- $zipPackage : ZipArchive
- $source : string
- $target : string
cleanupTempFile()
Cleanup temporary file.
protected
cleanupTempFile() : void
clearTempDir()
Clear temporary directory.
protected
clearTempDir() : void
getTempFile()
Get temporary file name.
protected
getTempFile(string $filename) : string
If $filename is php://output or php://stdout, make it a temporary file
Parameters
- $filename : string
Return values
stringgetZipArchive()
Get ZipArchive object.
protected
getZipArchive(string $filename) : ZipArchive
Parameters
- $filename : string
Return values
ZipArchiveopenFile()
Open file for writing.
protected
openFile(string $filename) : resource
Parameters
- $filename : string
Tags
Return values
resourcewriteFile()
Write content to file.
protected
writeFile(resource $fileHandle, string $content) : void
Parameters
- $fileHandle : resource
- $content : string