PHPWord/classes/PhpOffice-PhpWord-PhpWord.html

2537 lines
127 KiB
HTML
Raw 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>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
PhpWord
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">PHPWord main class</p>
<section class="phpdocumentor-description"></section>
<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 -constant -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#constant_DEFAULT_FONT_COLOR">DEFAULT_FONT_COLOR</a>
<span>
&nbsp;= PhpOfficePhpWordSettings::DEFAULT_FONT_COLOR </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#constant_DEFAULT_FONT_CONTENT_TYPE">DEFAULT_FONT_CONTENT_TYPE</a>
<span>
&nbsp;= PhpOfficePhpWordSettings::DEFAULT_FONT_CONTENT_TYPE </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#constant_DEFAULT_FONT_NAME">DEFAULT_FONT_NAME</a>
<span>
&nbsp;= PhpOfficePhpWordSettings::DEFAULT_FONT_NAME </span>
</dt>
<dd>Default font settings</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#constant_DEFAULT_FONT_SIZE">DEFAULT_FONT_SIZE</a>
<span>
&nbsp;= PhpOfficePhpWordSettings::DEFAULT_FONT_SIZE </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#property_collections">$collections</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Collections</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#property_metadata">$metadata</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Metadata</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#property_sections">$sections</a>
<span>
&nbsp;: array&lt;string|int, <a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a>&gt; </span>
</dt>
<dd>Collection of sections</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method___call">__call()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Dynamic function call to reduce static dependency</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Create new instance</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addBookmark">addBookmark()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addChart">addChart()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addComment">addComment()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addEndnote">addEndnote()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addFontStyle">addFontStyle()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addFootnote">addFootnote()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addLinkStyle">addLinkStyle()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addNumberingStyle">addNumberingStyle()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addParagraphStyle">addParagraphStyle()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addSection">addSection()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a> </span>
</dt>
<dd>Create new section</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addTableStyle">addTableStyle()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addTitle">addTitle()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addTitleStyle">addTitleStyle()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_createSection">createSection()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a> </span>
</dt>
<dd>Create new section</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getCharts">getCharts()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getComments">getComments()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getCompatibility">getCompatibility()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Metadata-Compatibility.html"><abbr title="\PhpOffice\PhpWord\Metadata\Compatibility">Compatibility</abbr></a> </span>
</dt>
<dd>Get compatibility</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getDefaultFontName">getDefaultFontName()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get default font name</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getDefaultFontSize">getDefaultFontSize()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Get default font size</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getDocInfo">getDocInfo()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Metadata-DocInfo.html"><abbr title="\PhpOffice\PhpWord\Metadata\DocInfo">DocInfo</abbr></a> </span>
</dt>
<dd>Get document properties object</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getDocumentProperties">getDocumentProperties()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Metadata-DocInfo.html"><abbr title="\PhpOffice\PhpWord\Metadata\DocInfo">DocInfo</abbr></a> </span>
</dt>
<dd>Get document properties object</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getEndnotes">getEndnotes()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getFootnotes">getFootnotes()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getProtection">getProtection()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Metadata-Protection.html"><abbr title="\PhpOffice\PhpWord\Metadata\Protection">Protection</abbr></a> </span>
</dt>
<dd>Get protection</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getSection">getSection()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a>|null </span>
</dt>
<dd>Returns the section at the requested position</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getSections">getSections()</a>
<span>
&nbsp;: array&lt;string|int, <a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a>&gt; </span>
</dt>
<dd>Get all sections</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getSettings">getSettings()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Metadata-Settings.html"><abbr title="\PhpOffice\PhpWord\Metadata\Settings">Settings</abbr></a> </span>
</dt>
<dd>Get compatibility</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getTitles">getTitles()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_loadTemplate">loadTemplate()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-TemplateProcessor.html"><abbr title="\PhpOffice\PhpWord\TemplateProcessor">TemplateProcessor</abbr></a> </span>
</dt>
<dd>Load template by filename</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_save">save()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Save to file or download</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_setDefaultFontName">setDefaultFontName()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set default font name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_setDefaultFontSize">setDefaultFontSize()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set default font size.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_setDefaultParagraphStyle">setDefaultParagraphStyle()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Style-Paragraph.html"><abbr title="\PhpOffice\PhpWord\Style\Paragraph">Paragraph</abbr></a> </span>
</dt>
<dd>Set default paragraph style definition to styles.xml</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_setDocumentProperties">setDocumentProperties()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set document properties object</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_sortSections">sortSections()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Sorts the sections using the callable passed</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/PhpOffice-PhpWord-PhpWord.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public -deprecated">
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_FONT_COLOR">
DEFAULT_FONT_COLOR
<a href="classes/PhpOffice-PhpWord-PhpWord.html#constant_DEFAULT_FONT_COLOR" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">DEFAULT_FONT_COLOR</span>
= <span class="phpdocumentor-signature__default-value">PhpOfficePhpWordSettings::DEFAULT_FONT_COLOR</span>
</code>
<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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.11.0</span>
<section class="phpdocumentor-description"><p>Use Settings constants</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public -deprecated">
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_FONT_CONTENT_TYPE">
DEFAULT_FONT_CONTENT_TYPE
<a href="classes/PhpOffice-PhpWord-PhpWord.html#constant_DEFAULT_FONT_CONTENT_TYPE" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">DEFAULT_FONT_CONTENT_TYPE</span>
= <span class="phpdocumentor-signature__default-value">PhpOfficePhpWordSettings::DEFAULT_FONT_CONTENT_TYPE</span>
</code>
<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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.11.0</span>
<section class="phpdocumentor-description"><p>Use Settings constants</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public -deprecated">
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_FONT_NAME">
DEFAULT_FONT_NAME
<a href="classes/PhpOffice-PhpWord-PhpWord.html#constant_DEFAULT_FONT_NAME" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Default font settings</p>
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">DEFAULT_FONT_NAME</span>
= <span class="phpdocumentor-signature__default-value">PhpOfficePhpWordSettings::DEFAULT_FONT_NAME</span>
</code>
<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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.11.0</span>
<section class="phpdocumentor-description"><p>Use Settings constants</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">const</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>string|int</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public -deprecated">
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_FONT_SIZE">
DEFAULT_FONT_SIZE
<a href="classes/PhpOffice-PhpWord-PhpWord.html#constant_DEFAULT_FONT_SIZE" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">DEFAULT_FONT_SIZE</span>
= <span class="phpdocumentor-signature__default-value">PhpOfficePhpWordSettings::DEFAULT_FONT_SIZE</span>
</code>
<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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.11.0</span>
<section class="phpdocumentor-description"><p>Use Settings constants</p>
</section>
</dd>
</dl>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/PhpOffice-PhpWord-PhpWord.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_collections">
$collections
<a href="classes/PhpOffice-PhpWord-PhpWord.html#property_collections" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">80</span>
</aside>
<p class="phpdocumentor-summary">Collections</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">$collections</span>
= <span class="phpdocumentor-signature__default-value">array()</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_metadata">
$metadata
<a href="classes/PhpOffice-PhpWord-PhpWord.html#property_metadata" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">88</span>
</aside>
<p class="phpdocumentor-summary">Metadata</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">$metadata</span>
= <span class="phpdocumentor-signature__default-value">array()</span></code>
<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.12.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_sections">
$sections
<a href="classes/PhpOffice-PhpWord-PhpWord.html#property_sections" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Collection of sections</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, <a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a>&gt;</span>
<span class="phpdocumentor-signature__name">$sections</span>
= <span class="phpdocumentor-signature__default-value">array()</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-PhpWord.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___call">
__call()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method___call" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">128</span>
</aside>
<p class="phpdocumentor-summary">Dynamic function call to reduce static dependency</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$function</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$function</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</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">$args</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<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.12.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\BadMethodCallException">BadMethodCallException</abbr></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method___construct" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">95</span>
</aside>
<p class="phpdocumentor-summary">Create new instance</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Collections are created dynamically</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addBookmark">
addBookmark()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addBookmark" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addBookmark</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Bookmark.html"><abbr title="\PhpOffice\PhpWord\Element\Bookmark">Bookmark</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bookmark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$bookmark</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Bookmark.html"><abbr title="\PhpOffice\PhpWord\Element\Bookmark">Bookmark</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addChart">
addChart()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addChart" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addChart</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Chart.html"><abbr title="\PhpOffice\PhpWord\Element\Chart">Chart</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$chart</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$chart</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Chart.html"><abbr title="\PhpOffice\PhpWord\Element\Chart">Chart</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addComment">
addComment()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addComment" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addComment</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$comment</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$comment</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addEndnote">
addEndnote()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addEndnote" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addEndnote</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Endnote.html"><abbr title="\PhpOffice\PhpWord\Element\Endnote">Endnote</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$endnote</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$endnote</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Endnote.html"><abbr title="\PhpOffice\PhpWord\Element\Endnote">Endnote</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addFontStyle">
addFontStyle()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addFontStyle" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addFontStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styleName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fontStyle</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$paragraphStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$styleName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fontStyle</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$paragraphStyle = null</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addFootnote">
addFootnote()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addFootnote" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addFootnote</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Footnote.html"><abbr title="\PhpOffice\PhpWord\Element\Footnote">Footnote</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$footnote</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$footnote</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Footnote.html"><abbr title="\PhpOffice\PhpWord\Element\Footnote">Footnote</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addLinkStyle">
addLinkStyle()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addLinkStyle" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addLinkStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styleName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styles</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$styleName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$styles</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addNumberingStyle">
addNumberingStyle()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addNumberingStyle" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addNumberingStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styleName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styles</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$styleName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$styles</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addParagraphStyle">
addParagraphStyle()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addParagraphStyle" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addParagraphStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styleName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styles</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$styleName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$styles</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addSection">
addSection()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addSection" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">249</span>
</aside>
<p class="phpdocumentor-summary">Create new section</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addSection</span><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">$style</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"><a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a></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">$style</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</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"><a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addTableStyle">
addTableStyle()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addTableStyle" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addTableStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styleName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styleTable</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styleFirstRow = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$styleName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$styleTable</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$styleFirstRow = null</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addTitle">
addTitle()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addTitle" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addTitle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Title.html"><abbr title="\PhpOffice\PhpWord\Element\Title">Title</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$title</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$title</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Title.html"><abbr title="\PhpOffice\PhpWord\Element\Title">Title</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addTitleStyle">
addTitleStyle()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_addTitleStyle" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addTitleStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$depth</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fontStyle</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$paragraphStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></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">$depth</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fontStyle</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$paragraphStyle = null</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_createSection">
createSection()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_createSection" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">389</span>
</aside>
<p class="phpdocumentor-summary">Create new section</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">createSection</span><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">$settings</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"><a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a></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">$settings</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</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-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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.10.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getCharts">
getCharts()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getCharts" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getCharts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getComments">
getComments()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getComments" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getComments</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getCompatibility">
getCompatibility()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getCompatibility" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">202</span>
</aside>
<p class="phpdocumentor-summary">Get compatibility</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getCompatibility</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Metadata-Compatibility.html"><abbr title="\PhpOffice\PhpWord\Metadata\Compatibility">Compatibility</abbr></a></span></code>
<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.12.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Metadata-Compatibility.html"><abbr title="\PhpOffice\PhpWord\Metadata\Compatibility">Compatibility</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDefaultFontName">
getDefaultFontName()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getDefaultFontName" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">274</span>
</aside>
<p class="phpdocumentor-summary">Get default font name</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDefaultFontName</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
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDefaultFontSize">
getDefaultFontSize()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getDefaultFontSize" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">294</span>
</aside>
<p class="phpdocumentor-summary">Get default font size</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDefaultFontSize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDocInfo">
getDocInfo()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getDocInfo" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">178</span>
</aside>
<p class="phpdocumentor-summary">Get document properties object</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDocInfo</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Metadata-DocInfo.html"><abbr title="\PhpOffice\PhpWord\Metadata\DocInfo">DocInfo</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-Metadata-DocInfo.html"><abbr title="\PhpOffice\PhpWord\Metadata\DocInfo">DocInfo</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_getDocumentProperties">
getDocumentProperties()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getDocumentProperties" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">403</span>
</aside>
<p class="phpdocumentor-summary">Get document properties object</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDocumentProperties</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Metadata-DocInfo.html"><abbr title="\PhpOffice\PhpWord\Metadata\DocInfo">DocInfo</abbr></a></span></code>
<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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.12.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Metadata-DocInfo.html"><abbr title="\PhpOffice\PhpWord\Metadata\DocInfo">DocInfo</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getEndnotes">
getEndnotes()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getEndnotes" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getEndnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getFootnotes">
getFootnotes()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getFootnotes" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getFootnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_getProtection">
getProtection()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getProtection" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">191</span>
</aside>
<p class="phpdocumentor-summary">Get protection</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getProtection</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Metadata-Protection.html"><abbr title="\PhpOffice\PhpWord\Metadata\Protection">Protection</abbr></a></span></code>
<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.12.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Get the Document protection from PhpWord-&gt;getSettings()-&gt;getDocumentProtection();</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Metadata-Protection.html"><abbr title="\PhpOffice\PhpWord\Metadata\Protection">Protection</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSection">
getSection()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getSection" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">234</span>
</aside>
<p class="phpdocumentor-summary">Returns the section at the requested position</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSection</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$index</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a>|null</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">$index</span>
: <span class="phpdocumentor-signature__argument__return-type">int</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"><a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a>|null</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSections">
getSections()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getSections" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">223</span>
</aside>
<p class="phpdocumentor-summary">Get all sections</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSections</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a>&gt;</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/PhpOffice-PhpWord-Element-Section.html"><abbr title="\PhpOffice\PhpWord\Element\Section">Section</abbr></a>&gt;</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSettings">
getSettings()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getSettings" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">213</span>
</aside>
<p class="phpdocumentor-summary">Get compatibility</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSettings</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Metadata-Settings.html"><abbr title="\PhpOffice\PhpWord\Metadata\Settings">Settings</abbr></a></span></code>
<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.14.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Metadata-Settings.html"><abbr title="\PhpOffice\PhpWord\Metadata\Settings">Settings</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getTitles">
getTitles()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_getTitles" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getTitles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_loadTemplate">
loadTemplate()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_loadTemplate" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">333</span>
</aside>
<p class="phpdocumentor-summary">Load template by filename</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">loadTemplate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filename</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-TemplateProcessor.html"><abbr title="\PhpOffice\PhpWord\TemplateProcessor">TemplateProcessor</abbr></a></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">$filename</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Fully qualified filename</p>
</section>
</dd>
</dl>
<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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.12.0</span>
<section class="phpdocumentor-description"><p>Use <code class="prettyprint">new TemplateProcessor($documentTemplate)</code> instead.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/PhpOffice-PhpWord-Exception-Exception.html"><abbr title="\PhpOffice\PhpWord\Exception\Exception">Exception</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-TemplateProcessor.html"><abbr title="\PhpOffice\PhpWord\TemplateProcessor">TemplateProcessor</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_save">
save()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_save" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">351</span>
</aside>
<p class="phpdocumentor-summary">Save to file or download</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">save</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filename</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">$format</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;Word2007&#039;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$download</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<section class="phpdocumentor-description"><p>All exceptions should already been handled by the writers</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">$filename</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">$format</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;Word2007&#039;</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">$download</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</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">bool</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setDefaultFontName">
setDefaultFontName()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_setDefaultFontName" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">284</span>
</aside>
<p class="phpdocumentor-summary">Set default font name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setDefaultFontName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fontName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$fontName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setDefaultFontSize">
setDefaultFontSize()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_setDefaultFontSize" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">304</span>
</aside>
<p class="phpdocumentor-summary">Set default font size.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setDefaultFontSize</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fontSize</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$fontSize</span>
: <span class="phpdocumentor-signature__argument__return-type">int</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">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setDefaultParagraphStyle">
setDefaultParagraphStyle()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_setDefaultParagraphStyle" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">315</span>
</aside>
<p class="phpdocumentor-summary">Set default paragraph style definition to styles.xml</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setDefaultParagraphStyle</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">$styles</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Style-Paragraph.html"><abbr title="\PhpOffice\PhpWord\Style\Paragraph">Paragraph</abbr></a></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">$styles</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"><p>Paragraph style definition</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Style-Paragraph.html"><abbr title="\PhpOffice\PhpWord\Style\Paragraph">Paragraph</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_setDocumentProperties">
setDocumentProperties()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_setDocumentProperties" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">419</span>
</aside>
<p class="phpdocumentor-summary">Set document properties object</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setDocumentProperties</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Metadata-DocInfo.html"><abbr title="\PhpOffice\PhpWord\Metadata\DocInfo">DocInfo</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$documentProperties</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">$documentProperties</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Metadata-DocInfo.html"><abbr title="\PhpOffice\PhpWord\Metadata\DocInfo">DocInfo</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.12.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
</dt>
<dd class="phpdocumentor-tag-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_sortSections">
sortSections()
<a href="classes/PhpOffice-PhpWord-PhpWord.html#method_sortSections" 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/PhpWord.php"><a href="files/src-phpword-phpword.html"><abbr title="src/PhpWord/PhpWord.php">PhpWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">264</span>
</aside>
<p class="phpdocumentor-summary">Sorts the sections using the callable passed</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">sortSections</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">callable&nbsp;</span><span class="phpdocumentor-signature__argument__name">$sorter</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$sorter</span>
: <span class="phpdocumentor-signature__argument__return-type">callable</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<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">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="http://php.net/manual/en/function.usort.php"><abbr title="http://php.net/manual/en/function.usort.php">http://php.net/manual/en/function.usort.php</abbr></a></span>
<section class="phpdocumentor-description"><p>for usage</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</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-PhpWord.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>