Documentation

RTF extends AbstractReader implements ReaderInterface

RTF Reader class

Tags
since
0.11.0

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?
getReadDataOnly()  : mixed
Read data only?
isReadDataOnly()  : bool
Read data only?
load()  : PhpWord
Loads PhpWord from file
setReadDataOnly()  : self
Set read data only
openFile()  : resource
Open file for reading

Properties

$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

getReadDataOnly()

Read data only?

public getReadDataOnly() : mixed
Tags
deprecated
0.10.0
codeCoverageIgnore
Return values
mixed

isReadDataOnly()

Read data only?

public isReadDataOnly() : bool
Return values
bool

load()

Loads PhpWord from file

public load(string $docFile) : PhpWord
Parameters
$docFile : string
Tags
throws
Exception
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
Tags
throws
Exception
Return values
resource

Search results