Aix/PHPWord
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
PHPWord/classes/PhpOffice-PhpWord-Writer-ODText.html

1534 lines
74 KiB
HTML
Raw Permalink Normal View History

deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/phpoffice.html"><abbr title="\PhpOffice">PhpOffice</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/phpoffice-phpword.html"><abbr title="\PhpOffice\PhpWord">PhpWord</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice.html">PhpOffice</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword.html">PhpWord</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-writer.html">Writer</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
ODText
<span class="phpdocumentor-element__extends">
extends <a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a>
</span>
<span class="phpdocumentor-element__implements">
implements
<a href="classes/PhpOffice-PhpWord-Writer-WriterInterface.html"><abbr title="\PhpOffice\PhpWord\Writer\WriterInterface">WriterInterface</abbr></a> </span>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/ODText.php"><a href="files/src-phpword-writer-odtext.html"><abbr title="src/PhpWord/Writer/ODText.php">ODText.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">ODText writer.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<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.7.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h3 id="interfaces_class_traits">
Interfaces, Classes and Traits
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/PhpOffice-PhpWord-Writer-WriterInterface.html"><abbr title="\PhpOffice\PhpWord\Writer\WriterInterface">WriterInterface</abbr></a></dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Writer interface.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dl>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_mediaPaths">$mediaPaths</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Paths to store media files.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_parts">$parts</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Part name and file name pairs.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_phpWord">$phpWord</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a> </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>PHPWord object.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_writerParts">$writerParts</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Individual writers.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_diskCachingDirectory">$diskCachingDirectory</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Disk caching directory.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_originalFilename">$originalFilename</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Original file name.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_tempDir">$tempDir</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Temporary directory.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_tempFilename">$tempFilename</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Temporary file name.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_useDiskCaching">$useDiskCaching</a>
<span>
&nbsp;: bool </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Use disk caching.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-ODText.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Create new ODText writer.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getDiskCachingDirectory">getDiskCachingDirectory()</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Get disk caching directory.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getPhpWord">getPhpWord()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a> </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Get PhpWord object.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getTempDir">getTempDir()</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Get temporary directory.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getWriterPart">getWriterPart()</a>
<span>
&nbsp;: mixed </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Get writer part.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_isUseDiskCaching">isUseDiskCaching()</a>
<span>
&nbsp;: bool </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Get use disk caching status.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-ODText.html#method_save">save()</a>
<span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
&nbsp;: void </span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dt>
<dd>Save PhpWord to file.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_setPhpWord">setPhpWord()</a>
<span>
&nbsp;: self </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Set PhpWord object.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_setTempDir">setTempDir()</a>
<span>
&nbsp;: self </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Set temporary directory.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_setUseDiskCaching">setUseDiskCaching()</a>
<span>
&nbsp;: self </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Set use disk caching status.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_addFilesToPackage">addFilesToPackage()</a>
<span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
&nbsp;: void </span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dt>
<dd>Add files to package.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_addFileToPackage">addFileToPackage()</a>
<span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
&nbsp;: void </span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dt>
<dd>Add file to package.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_cleanupTempFile">cleanupTempFile()</a>
<span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
&nbsp;: void </span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dt>
<dd>Cleanup temporary file.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_clearTempDir">clearTempDir()</a>
<span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
&nbsp;: void </span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dt>
<dd>Clear temporary directory.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getTempFile">getTempFile()</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Get temporary file name.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getZipArchive">getZipArchive()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html"><abbr title="\PhpOffice\PhpWord\Shared\ZipArchive">ZipArchive</abbr></a> </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Get ZipArchive object.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_openFile">openFile()</a>
<span>
&nbsp;: resource </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Open file for writing.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_writeFile">writeFile()</a>
<span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
&nbsp;: void </span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dt>
<dd>Write content to file.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_deleteDir">deleteDir()</a>
<span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
&nbsp;: void </span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dt>
<dd>Delete directory.</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/PhpOffice-PhpWord-Writer-ODText.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_mediaPaths">
$mediaPaths
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_mediaPaths" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Paths to store media files.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$mediaPaths</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
= <span class="phpdocumentor-signature__default-value">[&#039;image&#039; =&gt; &#039;&#039;, &#039;object&#039; =&gt; &#039;&#039;]</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_parts">
$parts
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_parts" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Part name and file name pairs.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$parts</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
= <span class="phpdocumentor-signature__default-value">[]</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_phpWord">
$phpWord
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_phpWord" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">PHPWord object.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a></span>
<span class="phpdocumentor-signature__name">$phpWord</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
</code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_writerParts">
$writerParts
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_writerParts" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Individual writers.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$writerParts</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
= <span class="phpdocumentor-signature__default-value">[]</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_diskCachingDirectory">
$diskCachingDirectory
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_diskCachingDirectory" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Disk caching directory.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$diskCachingDirectory</span>
= <span class="phpdocumentor-signature__default-value">&#039;./&#039;</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_originalFilename">
$originalFilename
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_originalFilename" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Original file name.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$originalFilename</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_tempDir">
$tempDir
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_tempDir" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">80</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Temporary directory.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$tempDir</span>
= <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_tempFilename">
$tempFilename
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_tempFilename" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Temporary file name.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$tempFilename</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_useDiskCaching">
$useDiskCaching
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#property_useDiskCaching" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Use disk caching.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$useDiskCaching</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
<section class="phpdocumentor-description"></section>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/PhpOffice-PhpWord-Writer-ODText.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___construct">
__construct()
<a href="classes/PhpOffice-PhpWord-Writer-ODText.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/Writer/ODText.php"><a href="files/src-phpword-writer-odtext.html"><abbr title="src/PhpWord/Writer/ODText.php">ODText.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Create new ODText writer.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$phpWord</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">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">$phpWord</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a></span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDiskCachingDirectory">
getDiskCachingDirectory()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getDiskCachingDirectory" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">178</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Get disk caching directory.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDiskCachingDirectory</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_getPhpWord">
getPhpWord()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getPhpWord" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">101</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Get PhpWord object.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getPhpWord</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</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-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getTempDir">
getTempDir()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getTempDir" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">188</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Get temporary directory.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getTempDir</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_getWriterPart">
getWriterPart()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getWriterPart" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">131</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Get writer part.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getWriterPart</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$partName</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">$partName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Writer part name</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>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_isUseDiskCaching">
isUseDiskCaching()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_isUseDiskCaching" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">145</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Get use disk caching status.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">isUseDiskCaching</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<section class="phpdocumentor-description"></section>
<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_save">
save()
<a href="classes/PhpOffice-PhpWord-Writer-ODText.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/Writer/ODText.php"><a href="files/src-phpword-writer-odtext.html"><abbr title="src/PhpWord/Writer/ODText.php">ODText.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Save PhpWord to file.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">save</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filename</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<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>
= <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>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setPhpWord">
setPhpWord()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_setPhpWord" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">117</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Set PhpWord object.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">setPhpWord</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$phpWord</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">self</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<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">$phpWord</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a>|null</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
= <span class="phpdocumentor-signature__argument__default-value">null</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">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setTempDir">
setTempDir()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_setTempDir" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">200</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Set temporary directory.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setTempDir</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</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">$value</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">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setUseDiskCaching">
setUseDiskCaching()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_setUseDiskCaching" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">158</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Set use disk caching status.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setUseDiskCaching</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</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">$directory</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">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">$value</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>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$directory</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_addFilesToPackage">
addFilesToPackage()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_addFilesToPackage" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">337</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
<p class="phpdocumentor-summary">Add files to package.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">addFilesToPackage</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html"><abbr title="\PhpOffice\PhpWord\Shared\ZipArchive">ZipArchive</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$zip</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">$elements</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<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">$zip</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html"><abbr title="\PhpOffice\PhpWord\Shared\ZipArchive">ZipArchive</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$elements</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-return-value__heading">Return values</h5>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_addFileToPackage">
addFileToPackage()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_addFileToPackage" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">376</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
<p class="phpdocumentor-summary">Add file to package.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">addFileToPackage</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html"><abbr title="\PhpOffice\PhpWord\Shared\ZipArchive">ZipArchive</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$zipPackage</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$source</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$target</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"><p>Get the actual source from an archive image.</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">$zipPackage</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html"><abbr title="\PhpOffice\PhpWord\Shared\ZipArchive">ZipArchive</abbr></a></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">$source</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">$target</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>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_cleanupTempFile">
cleanupTempFile()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_cleanupTempFile" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">240</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
<p class="phpdocumentor-summary">Cleanup temporary file.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">cleanupTempFile</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_clearTempDir">
clearTempDir()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_clearTempDir" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">258</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
<p class="phpdocumentor-summary">Clear temporary directory.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">clearTempDir</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_getTempFile">
getTempFile()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getTempFile" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">219</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Get temporary file name.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getTempFile</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">string</span></code>
<section class="phpdocumentor-description"><p>If $filename is php://output or php://stdout, make it a temporary file</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>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_getZipArchive">
getZipArchive()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_getZipArchive" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">272</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Get ZipArchive object.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getZipArchive</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-Shared-ZipArchive.html"><abbr title="\PhpOffice\PhpWord\Shared\ZipArchive">ZipArchive</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"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html"><abbr title="\PhpOffice\PhpWord\Shared\ZipArchive">ZipArchive</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_openFile">
openFile()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_openFile" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">303</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Open file for writing.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">openFile</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">resource</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"></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.11.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">resource</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_writeFile">
writeFile()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_writeFile" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">325</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
<p class="phpdocumentor-summary">Write content to file.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">writeFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">resource&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fileHandle</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$content</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<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">$fileHandle</span>
: <span class="phpdocumentor-signature__argument__return-type">resource</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">$content</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-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.11.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_deleteDir">
deleteDir()
<a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html#method_deleteDir" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/AbstractWriter.php"><a href="files/src-phpword-writer-abstractwriter.html"><abbr title="src/PhpWord/Writer/AbstractWriter.php">AbstractWriter.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">406</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
<p class="phpdocumentor-summary">Delete directory.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">deleteDir</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$dir</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<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">$dir</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>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/PhpOffice-PhpWord-Writer-ODText.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>
Reference in New Issue Copy Permalink