PHPWord/classes/PhpOffice-PhpWord-Writer-Word2007-Part-RelsPart.html

806 lines
43 KiB
HTML
Raw Permalink Normal View History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/phpoffice.html"><abbr title="\PhpOffice">PhpOffice</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/phpoffice-phpword.html"><abbr title="\PhpOffice\PhpWord">PhpWord</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice.html">PhpOffice</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword.html">PhpWord</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-writer.html">Writer</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-writer-word2007.html">Word2007</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-writer-word2007-part.html">Part</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
RelsPart
<span class="phpdocumentor-element__extends">
extends <a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-Rels.html"><abbr title="\PhpOffice\PhpWord\Writer\Word2007\Part\Rels">Rels</abbr></a>
</span>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/RelsPart.php"><a href="files/src-phpword-writer-word2007-part-relspart.html"><abbr title="src/PhpWord/Writer/Word2007/Part/RelsPart.php">RelsPart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Word2007 part relationship writer: word/_rels/(header|footer|footnotes|endnotes)*.xml.rels.</p>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.11.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#property_dateFormat">$dateFormat</a>
<span>
&nbsp;: string </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#property_parentWriter">$parentWriter</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a> </span>
</dt>
<dd>Parent writer.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-RelsPart.html#property_media">$media</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Media relationships.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#method_getParentWriter">getParentWriter()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a> </span>
</dt>
<dd>Get parent writer.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-RelsPart.html#method_setMedia">setMedia()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set media.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#method_setParentWriter">setParentWriter()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set parent writer.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-RelsPart.html#method_write">write()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Write part.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#method_getXmlWriter">getXmlWriter()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a> </span>
</dt>
<dd>Get XML Writer.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-Rels.html#method_writeRels">writeRels()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Write relationships.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#method_writeText">writeText()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled().</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-Rels.html#method_writeMediaRel">writeMediaRel()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Write media relationships.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-Rels.html#method_writeRel">writeRel()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Write individual rels entry.</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-RelsPart.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_dateFormat">
$dateFormat
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#property_dateFormat" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php"><a href="files/src-phpword-writer-word2007-part-abstractpart.html"><abbr title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php">AbstractPart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$dateFormat</span>
= <span class="phpdocumentor-signature__default-value">&#039;Y-m-d\TH:i:sP&#039;</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_parentWriter">
$parentWriter
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#property_parentWriter" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php"><a href="files/src-phpword-writer-word2007-part-abstractpart.html"><abbr title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php">AbstractPart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<p class="phpdocumentor-summary">Parent writer.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a></span>
<span class="phpdocumentor-signature__name">$parentWriter</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_media">
$media
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-RelsPart.html#property_media" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/RelsPart.php"><a href="files/src-phpword-writer-word2007-part-relspart.html"><abbr title="src/PhpWord/Writer/Word2007/Part/RelsPart.php">RelsPart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Media relationships.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$media</span>
= <span class="phpdocumentor-signature__default-value">[]</span></code>
<section class="phpdocumentor-description"></section>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-RelsPart.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getParentWriter">
getParentWriter()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#method_getParentWriter" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php"><a href="files/src-phpword-writer-word2007-part-abstractpart.html"><abbr title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php">AbstractPart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Get parent writer.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getParentWriter</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setMedia">
setMedia()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-RelsPart.html#method_setMedia" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/RelsPart.php"><a href="files/src-phpword-writer-word2007-part-relspart.html"><abbr title="src/PhpWord/Writer/Word2007/Part/RelsPart.php">RelsPart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Set media.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setMedia</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$media</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$media</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setParentWriter">
setParentWriter()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#method_setParentWriter" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php"><a href="files/src-phpword-writer-word2007-part-abstractpart.html"><abbr title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php">AbstractPart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Set parent writer.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setParentWriter</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$writer</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$writer</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a></span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_write">
write()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-RelsPart.html#method_write" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/RelsPart.php"><a href="files/src-phpword-writer-word2007-part-relspart.html"><abbr title="src/PhpWord/Writer/Word2007/Part/RelsPart.php">RelsPart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Write part.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">write</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_getXmlWriter">
getXmlWriter()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#method_getXmlWriter" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php"><a href="files/src-phpword-writer-word2007-part-abstractpart.html"><abbr title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php">AbstractPart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">78</span>
</aside>
<p class="phpdocumentor-summary">Get XML Writer.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getXmlWriter</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_writeRels">
writeRels()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-Rels.html#method_writeRels" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/Rels.php"><a href="files/src-phpword-writer-word2007-part-rels.html"><abbr title="src/PhpWord/Writer/Word2007/Part/Rels.php">Rels.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Write relationships.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">writeRels</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$xmlWriter</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$xmlRels</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mediaRels</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$relId</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$xmlWriter</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$xmlRels</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$mediaRels</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$relId</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">1</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_writeText">
writeText()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-AbstractPart.html#method_writeText" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php"><a href="files/src-phpword-writer-word2007-part-abstractpart.html"><abbr title="src/PhpWord/Writer/Word2007/Part/AbstractPart.php">AbstractPart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">100</span>
</aside>
<p class="phpdocumentor-summary">Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">writeText</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$content</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$content</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The text string to write</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>Returns true on success or false on failure</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_writeMediaRel">
writeMediaRel()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-Rels.html#method_writeMediaRel" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/Rels.php"><a href="files/src-phpword-writer-word2007-part-rels.html"><abbr title="src/PhpWord/Writer/Word2007/Part/Rels.php">Rels.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">81</span>
</aside>
<p class="phpdocumentor-summary">Write media relationships.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">writeMediaRel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$xmlWriter</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$relId</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mediaRel</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$xmlWriter</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$relId</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$mediaRel</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_writeRel">
writeRel()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-Rels.html#method_writeRel" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Part/Rels.php"><a href="files/src-phpword-writer-word2007-part-rels.html"><abbr title="src/PhpWord/Writer/Word2007/Part/Rels.php">Rels.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">107</span>
</aside>
<p class="phpdocumentor-summary">Write individual rels entry.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">writeRel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$xmlWriter</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$relId</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$target</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$targetMode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Format:
<Relationship Id="rId..." Type="http://..." Target="....xml" TargetMode="..." /></p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$xmlWriter</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$relId</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Relationship ID</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Relationship type</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$target</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Relationship target</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$targetMode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Relationship target mode</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Part-RelsPart.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>