ODText extends AbstractReader implements ReaderInterface
Reader for ODText.
Tags
Interfaces, Classes and Traits
- ReaderInterface
- Reader interface.
Table of Contents
- $fileHandle : bool|resource
- File pointer.
- $readDataOnly : bool
- Read data only?
- canRead() : bool
- Can the current ReaderInterface read the file?
- isReadDataOnly() : bool
- Read data only?
- load() : PhpWord
- Loads PhpWord from file.
- setReadDataOnly() : self
- Set read data only.
- openFile() : resource
- Open file for reading.
- readPart() : void
- Read document part.
- readRelationships() : array<string|int, mixed>
- Read all relationship files.
Properties
$fileHandle
File pointer.
protected
bool|resource
$fileHandle
$readDataOnly
Read data only?
protected
bool
$readDataOnly
= true
Methods
canRead()
Can the current ReaderInterface read the file?
public
canRead(string $filename) : bool
Parameters
- $filename : string
Return values
bool —isReadDataOnly()
Read data only?
public
isReadDataOnly() : bool
Return values
bool —load()
Loads PhpWord from file.
public
load(string $docFile) : PhpWord
Parameters
- $docFile : string
Return values
PhpWord —setReadDataOnly()
Set read data only.
public
setReadDataOnly([bool $value = true ]) : self
Parameters
- $value : bool = true
Return values
self —openFile()
Open file for reading.
protected
openFile(string $filename) : resource
Parameters
- $filename : string
Return values
resource —readPart()
Read document part.
private
readPart(PhpWord $phpWord, array<string|int, mixed> $relationships, string $partName, string $docFile, string $xmlFile) : void
Parameters
- $phpWord : PhpWord
- $relationships : array<string|int, mixed>
- $partName : string
- $docFile : string
- $xmlFile : string
Return values
void —readRelationships()
Read all relationship files.
private
readRelationships(string $docFile) : array<string|int, mixed>
Parameters
- $docFile : string