\PhpOffice\PhpWord\Writer\Word2007\PartRelsPart

Word2007 part relationship writer: word/_rels/(header|footer|footnotes|endnotes)*.xml.rels

Summary

Methods
Properties
Constants
write()
setParentWriter()
getParentWriter()
setMedia()
No public properties found
No constants found
writeRels()
getXmlWriter()
writeText()
$parentWriter
$dateFormat
N/A
writeMediaRel()
writeRel()
$media
N/A

Properties

$dateFormat

$dateFormat : string

Type

string — Date format

$media

$media : array

Media relationships

Type

array

Methods

write()

write() : string

Write part

Returns

string

setMedia()

setMedia(array  $media) : self

Set media

Parameters

array $media

Returns

self

writeRels()

writeRels(\PhpOffice\Common\XMLWriter  $xmlWriter, array  $xmlRels = array(), array  $mediaRels = array(), integer  $relId = 1) 

Write relationships.

Parameters

\PhpOffice\Common\XMLWriter $xmlWriter
array $xmlRels
array $mediaRels
integer $relId

writeText()

writeText(string  $content) : boolean

Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled()

Parameters

string $content

The text string to write

Returns

boolean —

Returns true on success or false on failure

writeMediaRel()

writeMediaRel(\PhpOffice\Common\XMLWriter  $xmlWriter, integer  $relId, array  $mediaRel) 

Write media relationships.

Parameters

\PhpOffice\Common\XMLWriter $xmlWriter
integer $relId
array $mediaRel

writeRel()

writeRel(\PhpOffice\Common\XMLWriter  $xmlWriter, integer  $relId, string  $type, string  $target, string  $targetMode = '') 

Write individual rels entry.

Format:

Parameters

\PhpOffice\Common\XMLWriter $xmlWriter
integer $relId

Relationship ID

string $type

Relationship type

string $target

Relationship target

string $targetMode

Relationship target mode

Throws

\PhpOffice\PhpWord\Exception\Exception