Constants

READ_VALUE

READ_VALUE = 'attributeValue'

Conversion method

READ_EQUAL

READ_EQUAL = 'attributeEquals'

READ_TRUE

READ_TRUE = 'attributeTrue'

READ_FALSE

READ_FALSE = 'attributeFalse'

READ_SIZE

READ_SIZE = 'attributeMultiplyByTwo'

Properties

$docFile

$docFile : string

Document file

Type

string

$xmlFile

$xmlFile : string

XML file

Type

string

$rels

$rels : array

Part relationships

Type

array

Methods

__construct()

__construct(string  $docFile, string  $xmlFile) 

Create new instance

Parameters

string $docFile
string $xmlFile

setRels()

setRels(array  $value) 

Set relationships.

Parameters

array $value

readRunChild()

readRunChild(\PhpOffice\Common\XMLReader  $xmlReader, \DOMElement  $node, \PhpOffice\PhpWord\Element\AbstractContainer  $parent, string  $docPart, mixed  $paragraphStyle = null, mixed  $fontStyle = null) 

Parses nodes under w:r

Parameters

\PhpOffice\Common\XMLReader $xmlReader
\DOMElement $node
\PhpOffice\PhpWord\Element\AbstractContainer $parent
string $docPart
mixed $paragraphStyle
mixed $fontStyle

readTable()

readTable(\PhpOffice\Common\XMLReader  $xmlReader, \DOMElement  $domNode, mixed  $parent, string  $docPart = 'document') 

Read w:tbl.

Parameters

\PhpOffice\Common\XMLReader $xmlReader
\DOMElement $domNode
mixed $parent
string $docPart

readParagraphStyle()

readParagraphStyle(\PhpOffice\Common\XMLReader  $xmlReader, \DOMElement  $domNode) : array|null

Read w:pPr.

Parameters

\PhpOffice\Common\XMLReader $xmlReader
\DOMElement $domNode

Returns

array|null

readFontStyle()

readFontStyle(\PhpOffice\Common\XMLReader  $xmlReader, \DOMElement  $domNode) : array|null

Read w:rPr

Parameters

\PhpOffice\Common\XMLReader $xmlReader
\DOMElement $domNode

Returns

array|null

readTableStyle()

readTableStyle(\PhpOffice\Common\XMLReader  $xmlReader, \DOMElement  $domNode) : string|array|null

Read w:tblPr

Parameters

\PhpOffice\Common\XMLReader $xmlReader
\DOMElement $domNode

Returns

string|array|null

readStyleDefs()

readStyleDefs(\PhpOffice\Common\XMLReader  $xmlReader, \DOMElement  $parentNode = null, array  $styleDefs = array()) : array

Read style definition

Parameters

\PhpOffice\Common\XMLReader $xmlReader
\DOMElement $parentNode
array $styleDefs

Returns

array

getHeadingDepth()

getHeadingDepth(array  $paragraphStyle = null) : \PhpOffice\PhpWord\Reader\Word2007\number|null

Returns the depth of the Heading, returns 0 for a Title

Parameters

array $paragraphStyle

Returns

\PhpOffice\PhpWord\Reader\Word2007\number|null

readTablePosition()

readTablePosition(\PhpOffice\Common\XMLReader  $xmlReader, \DOMElement  $domNode) : array

Read w:tblpPr

Parameters

\PhpOffice\Common\XMLReader $xmlReader
\DOMElement $domNode

Returns

array

readCellStyle()

readCellStyle(\PhpOffice\Common\XMLReader  $xmlReader, \DOMElement  $domNode) : array

Read w:tcPr

Parameters

\PhpOffice\Common\XMLReader $xmlReader
\DOMElement $domNode

Returns

array

findPossibleElement()

findPossibleElement(\PhpOffice\Common\XMLReader  $xmlReader, \DOMElement  $parentNode = null, string|array  $elements) : string|null

Returns the first child element found

Parameters

\PhpOffice\Common\XMLReader $xmlReader
\DOMElement $parentNode
string|array $elements

Returns

string|null

findPossibleAttribute()

findPossibleAttribute(\PhpOffice\Common\XMLReader  $xmlReader, \DOMElement  $node, string|array  $attributes) : string|null

Returns the first attribute found

Parameters

\PhpOffice\Common\XMLReader $xmlReader
\DOMElement $node
string|array $attributes

Returns

string|null

readStyleDef()

readStyleDef(string  $method, string|null  $attributeValue, mixed  $expected) : mixed

Return style definition based on conversion method

Parameters

string $method
string|null $attributeValue
mixed $expected

Returns

mixed

isOn()

isOn(string  $value = null) : boolean

Parses the value of the on/off value, null is considered true as it means the w:val attribute was not present

Parameters

string $value

Returns

boolean

getMediaTarget()

getMediaTarget(string  $docPart, string  $rId) : string|null

Returns the target of image, object, or link as stored in ::readMainRels

Parameters

string $docPart
string $rId

Returns

string|null

getTargetMode()

getTargetMode(string  $docPart, string  $rId) : string|null

Returns the target mode

Parameters

string $docPart
string $rId

Returns

string|null