Documentation

MsDoc extends AbstractReader implements ReaderInterface

Reader for Word97

Tags
since
0.10.0

Interfaces, Classes and Traits

ReaderInterface
Reader interface

Table of Contents

MSOBLIPCMYKJPEG  = 0x12
MSOBLIPDIB  = 0x7
MSOBLIPEMF  = 0x2
MSOBLIPERROR  = 0x0
MSOBLIPJPEG  = 0x5
MSOBLIPPICT  = 0x4
MSOBLIPPNG  = 0x6
MSOBLIPTIFF  = 0x11
MSOBLIPUNKNOWN  = 0x1
MSOBLIPWMF  = 0x3
OFFICEARTBLIPDIB  = 0xf01f
OFFICEARTBLIPEMF  = 0xf01a
OFFICEARTBLIPJPEG  = 0xf02a
OFFICEARTBLIPJPG  = 0xf01d
OFFICEARTBLIPPICT  = 0xf01c
OFFICEARTBLIPPNG  = 0xf01e
OFFICEARTBLIPTIFF  = 0xf029
OFFICEARTBLIPWMF  = 0xf01b
SPRA_VALUE  = 10
SPRA_VALUE_OPPOSITE  = 20
VERSION_2000  = '2000'
VERSION_2002  = '2002'
VERSION_2003  = '2003'
VERSION_2007  = '2007'
VERSION_97  = '97'
$fileHandle  : bool|resource
File pointer
$readDataOnly  : bool
Read data only?
$arrayCharacters  : array<string|int, stdClass>
$arrayFib  : array<string|int, mixed>
$arrayFonts  : array<string|int, string>
$arrayParagraphs  : array<string|int, string>
$arraySections  : array<string|int, stdClass>
$data1Table  : mixed
1Table Stream
$dataData  : mixed
Data Stream
$dataObjectPool  : mixed
Object Pool Stream
$dataWorkDocument  : mixed
WordDocument Stream
$phpWord  : PhpWord
PhpWord object
canRead()  : bool
Can the current ReaderInterface read the file?
getInt1d()  : int
Read 8-bit unsigned integer
getInt2d()  : int
Read 16-bit unsigned integer
getInt3d()  : int
Read 24-bit signed integer
getInt4d()  : int
Read 32-bit signed integer
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
generatePhpWord()  : mixed
getArrayCP()  : mixed
getNumInLcb()  : mixed
loadOLE()  : mixed
Load an OLE Document
loadRecordHeader()  : array<string|int, mixed>
Read a record header
readBlockFibRgFcLcb()  : mixed
readFib()  : mixed
readFibContent()  : mixed
readPrl()  : stdClass
readRecordPlcfBteChpx()  : mixed
Character formatting properties to text in a document
readRecordPlcfBtePapx()  : mixed
Paragraph and information about them
readRecordPlcfSed()  : mixed
Section and information about them
readRecordSttbfFfn()  : mixed
Specifies the fonts that are used in the document
readSprm()  : stdClass
readSprmSpra()  : array<string|int, mixed>

Constants

MSOBLIPCMYKJPEG

public mixed MSOBLIPCMYKJPEG = 0x12

MSOBLIPDIB

public mixed MSOBLIPDIB = 0x7

MSOBLIPEMF

public mixed MSOBLIPEMF = 0x2

MSOBLIPERROR

public mixed MSOBLIPERROR = 0x0

MSOBLIPJPEG

public mixed MSOBLIPJPEG = 0x5

MSOBLIPPICT

public mixed MSOBLIPPICT = 0x4

MSOBLIPPNG

public mixed MSOBLIPPNG = 0x6

MSOBLIPTIFF

public mixed MSOBLIPTIFF = 0x11

MSOBLIPUNKNOWN

public mixed MSOBLIPUNKNOWN = 0x1

MSOBLIPWMF

public mixed MSOBLIPWMF = 0x3

OFFICEARTBLIPDIB

public mixed OFFICEARTBLIPDIB = 0xf01f

OFFICEARTBLIPEMF

public mixed OFFICEARTBLIPEMF = 0xf01a

OFFICEARTBLIPJPEG

public mixed OFFICEARTBLIPJPEG = 0xf02a

OFFICEARTBLIPJPG

public mixed OFFICEARTBLIPJPG = 0xf01d

OFFICEARTBLIPPICT

public mixed OFFICEARTBLIPPICT = 0xf01c

OFFICEARTBLIPPNG

public mixed OFFICEARTBLIPPNG = 0xf01e

OFFICEARTBLIPTIFF

public mixed OFFICEARTBLIPTIFF = 0xf029

OFFICEARTBLIPWMF

public mixed OFFICEARTBLIPWMF = 0xf01b

SPRA_VALUE

public mixed SPRA_VALUE = 10

SPRA_VALUE_OPPOSITE

public mixed SPRA_VALUE_OPPOSITE = 20

VERSION_2000

public mixed VERSION_2000 = '2000'

VERSION_2002

public mixed VERSION_2002 = '2002'

VERSION_2003

public mixed VERSION_2003 = '2003'

VERSION_2007

public mixed VERSION_2007 = '2007'

VERSION_97

public mixed VERSION_97 = '97'

Properties

$readDataOnly

Read data only?

protected bool $readDataOnly = true

$arrayCharacters

private array<string|int, stdClass> $arrayCharacters = array()

$arrayFib

private array<string|int, mixed> $arrayFib = array()

$arrayFonts

private array<string|int, string> $arrayFonts = array()

$arrayParagraphs

private array<string|int, string> $arrayParagraphs = array()

$arraySections

private array<string|int, stdClass> $arraySections = array()

$data1Table

1Table Stream

private mixed $data1Table

$dataData

Data Stream

private mixed $dataData

$dataObjectPool

Object Pool Stream

private mixed $dataObjectPool

$dataWorkDocument

WordDocument Stream

private mixed $dataWorkDocument

Methods

canRead()

Can the current ReaderInterface read the file?

public canRead(string $filename) : bool
Parameters
$filename : string
Return values
bool —

getInt1d()

Read 8-bit unsigned integer

public static getInt1d(string $data, int $pos) : int
Parameters
$data : string
$pos : int
Return values
int —

getInt2d()

Read 16-bit unsigned integer

public static getInt2d(string $data, int $pos) : int
Parameters
$data : string
$pos : int
Return values
int —

getInt3d()

Read 24-bit signed integer

public static getInt3d(string $data, int $pos) : int
Parameters
$data : string
$pos : int
Return values
int —

getInt4d()

Read 32-bit signed integer

public static getInt4d(string $data, int $pos) : int
Parameters
$data : string
$pos : int
Return values
int —

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 $filename) : PhpWord
Parameters
$filename : 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
Tags
throws
Exception
Return values
resource —

generatePhpWord()

private generatePhpWord() : mixed
Return values
mixed —

getArrayCP()

private getArrayCP(mixed $data, mixed $posMem, mixed $iNum) : mixed
Parameters
$data : mixed
$posMem : mixed
$iNum : mixed
Return values
mixed —

getNumInLcb()

private getNumInLcb(mixed $lcb, mixed $iSize) : mixed
Parameters
$lcb : mixed
$iSize : mixed
Return values
mixed —

loadOLE()

Load an OLE Document

private loadOLE(string $filename) : mixed
Parameters
$filename : string
Return values
mixed —

loadRecordHeader()

Read a record header

private loadRecordHeader(string $stream, int $pos) : array<string|int, mixed>
Parameters
$stream : string
$pos : int
Return values
array<string|int, mixed> —

readBlockFibRgFcLcb()

private readBlockFibRgFcLcb(mixed $data, mixed $pos, mixed $version) : mixed
Parameters
$data : mixed
$pos : mixed
$version : mixed
Return values
mixed —

readFibContent()

private readFibContent() : mixed
Return values
mixed —

readRecordPlcfSed()

Section and information about them

private readRecordPlcfSed() : mixed
Tags
see
Return values
mixed —

readRecordSttbfFfn()

Specifies the fonts that are used in the document

private readRecordSttbfFfn() : mixed
Tags
see
Return values
mixed —

readSprm()

private readSprm( $sprm) : stdClass
Parameters
$sprm :
Return values
stdClass —

readSprmSpra()

private readSprmSpra(string $data, int $pos, stdClass $oSprm) : array<string|int, mixed>
Parameters
$data : string
$pos : int
$oSprm : stdClass
Return values
array<string|int, mixed> —

Search results