Rels extends AbstractPart
Word2007 main relationship writer: _rels/.rels
Tags
Table of Contents
- $dateFormat : string
- $parentWriter : AbstractWriter
- Parent writer
- getParentWriter() : AbstractWriter
- Get parent writer
- setParentWriter() : mixed
- Set parent writer.
- write() : string
- Write part
- getXmlWriter() : XMLWriter
- Get XML Writer
- writeRels() : mixed
- Write relationships.
- writeText() : bool
- Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled()
- writeMediaRel() : mixed
- Write media relationships.
- writeRel() : mixed
- Write individual rels entry.
Properties
$dateFormat
protected
string
$dateFormat
= 'Y-m-d\TH:i:sP'
$parentWriter
Parent writer
protected
AbstractWriter
$parentWriter
Methods
getParentWriter()
Get parent writer
public
getParentWriter() : AbstractWriter
Tags
Return values
AbstractWriter —setParentWriter()
Set parent writer.
public
setParentWriter([AbstractWriter $writer = null ]) : mixed
Parameters
- $writer : AbstractWriter = null
Return values
mixed —write()
Write part
public
write() : string
Return values
string —getXmlWriter()
Get XML Writer
protected
getXmlWriter() : XMLWriter
Return values
XMLWriter —writeRels()
Write relationships.
protected
writeRels(XMLWriter $xmlWriter[, array<string|int, mixed> $xmlRels = array() ][, array<string|int, mixed> $mediaRels = array() ][, int $relId = 1 ]) : mixed
Parameters
- $xmlWriter : XMLWriter
- $xmlRels : array<string|int, mixed> = array()
- $mediaRels : array<string|int, mixed> = array()
- $relId : int = 1
Return values
mixed —writeText()
Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled()
protected
writeText(string $content) : bool
Parameters
- $content : string
-
The text string to write
Return values
bool —Returns true on success or false on failure
writeMediaRel()
Write media relationships.
private
writeMediaRel(XMLWriter $xmlWriter, int $relId, array<string|int, mixed> $mediaRel) : mixed
Parameters
- $xmlWriter : XMLWriter
- $relId : int
- $mediaRel : array<string|int, mixed>
Return values
mixed —writeRel()
Write individual rels entry.
private
writeRel(XMLWriter $xmlWriter, int $relId, string $type, string $target[, string $targetMode = '' ]) : mixed
Format:
Parameters
- $xmlWriter : XMLWriter
- $relId : int
-
Relationship ID
- $type : string
-
Relationship type
- $target : string
-
Relationship target
- $targetMode : string = ''
-
Relationship target mode