ODText extends AbstractWriter implements WriterInterface
ODText writer
Tags
Interfaces, Classes and Traits
- WriterInterface
- Writer interface
Table of Contents
- $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
- $diskCachingDirectory : string
- Disk caching directory
- $originalFilename : string
- Original file name
- $tempDir : string
- Temporary directory
- $tempFilename : string
- Temporary file name
- $useDiskCaching : bool
- Use disk caching
- __construct() : mixed
- Create new ODText writer
- getDiskCachingDirectory() : string
- Get disk caching directory
- getPhpWord() : PhpWord
- Get PhpWord object
- getTempDir() : string
- Get temporary directory
- getUseDiskCaching() : mixed
- Get use disk caching status
- getWriterPart() : mixed
- Get writer part
- isUseDiskCaching() : bool
- Get use disk caching status
- save() : mixed
- Save PhpWord to file.
- setPhpWord() : self
- Set PhpWord object
- setTempDir() : self
- Set temporary directory
- setUseDiskCaching() : self
- Set use disk caching status
- addFilesToPackage() : mixed
- Add files to package.
- addFileToPackage() : mixed
- Add file to package.
- cleanupTempFile() : mixed
- Cleanup temporary file.
- clearTempDir() : mixed
- Clear temporary directory.
- getTempFile() : string
- Get temporary file name
- getZipArchive() : ZipArchive
- Get ZipArchive object
- openFile() : resource
- Open file for writing
- writeFile() : mixed
- Write content to file.
- deleteDir() : mixed
- Delete directory.
Properties
$mediaPaths
Paths to store media files
protected
array<string|int, mixed>
$mediaPaths
= array('image' => '', 'object' => '')
$parts
Part name and file name pairs
protected
array<string|int, mixed>
$parts
= array()
$phpWord
PHPWord object
protected
PhpWord
$phpWord
= null
$writerParts
Individual writers
protected
array<string|int, mixed>
$writerParts
= array()
$diskCachingDirectory
Disk caching directory
private
string
$diskCachingDirectory
= './'
$originalFilename
Original file name
private
string
$originalFilename
$tempDir
Temporary directory
private
string
$tempDir
= ''
$tempFilename
Temporary file name
private
string
$tempFilename
$useDiskCaching
Use disk caching
private
bool
$useDiskCaching
= false
Methods
__construct()
Create new ODText writer
public
__construct([PhpWord $phpWord = null ]) : mixed
Parameters
- $phpWord : PhpWord = null
Return values
mixed —getDiskCachingDirectory()
Get disk caching directory
public
getDiskCachingDirectory() : string
Return values
string —getPhpWord()
Get PhpWord object
public
getPhpWord() : PhpWord
Tags
Return values
PhpWord —getTempDir()
Get temporary directory
public
getTempDir() : string
Return values
string —getUseDiskCaching()
Get use disk caching status
public
getUseDiskCaching() : mixed
Tags
Return values
mixed —getWriterPart()
Get writer part
public
getWriterPart([string $partName = '' ]) : mixed
Parameters
- $partName : string = ''
-
Writer part name
Return values
mixed —isUseDiskCaching()
Get use disk caching status
public
isUseDiskCaching() : bool
Return values
bool —save()
Save PhpWord to file.
public
save([string $filename = null ]) : mixed
Parameters
- $filename : string = null
Return values
mixed —setPhpWord()
Set PhpWord object
public
setPhpWord([PhpWord $phpWord = null ]) : self
Parameters
- $phpWord : PhpWord = null
Return values
self —setTempDir()
Set temporary directory
public
setTempDir(string $value) : self
Parameters
- $value : string
Return values
self —setUseDiskCaching()
Set use disk caching status
public
setUseDiskCaching([bool $value = false ][, string $directory = null ]) : self
Parameters
- $value : bool = false
- $directory : string = null
Tags
Return values
self —addFilesToPackage()
Add files to package.
protected
addFilesToPackage(ZipArchive $zip, mixed $elements) : mixed
Parameters
- $zip : ZipArchive
- $elements : mixed
Return values
mixed —addFileToPackage()
Add file to package.
protected
addFileToPackage(ZipArchive $zipPackage, string $source, string $target) : mixed
Get the actual source from an archive image.
Parameters
- $zipPackage : ZipArchive
- $source : string
- $target : string
Return values
mixed —cleanupTempFile()
Cleanup temporary file.
protected
cleanupTempFile() : mixed
Tags
Return values
mixed —clearTempDir()
Clear temporary directory.
protected
clearTempDir() : mixed
Return values
mixed —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
string —getZipArchive()
Get ZipArchive object
protected
getZipArchive(string $filename) : ZipArchive
Parameters
- $filename : string
Tags
Return values
ZipArchive —openFile()
Open file for writing
protected
openFile(string $filename) : resource
Parameters
- $filename : string
Tags
Return values
resource —writeFile()
Write content to file.
protected
writeFile(resource $fileHandle, string $content) : mixed
Parameters
- $fileHandle : resource
- $content : string
Tags
Return values
mixed —deleteDir()
Delete directory.
private
deleteDir(string $dir) : mixed
Parameters
- $dir : string