2281 lines
102 KiB
HTML
2281 lines
102 KiB
HTML
<!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">
|
|
Settings
|
|
|
|
|
|
|
|
|
|
</h2>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">25</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">PHPWord settings class.</p>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">0.8.0</span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_DEFAULT_FONT_COLOR">DEFAULT_FONT_COLOR</a>
|
|
<span>
|
|
= '000000' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_DEFAULT_FONT_CONTENT_TYPE">DEFAULT_FONT_CONTENT_TYPE</a>
|
|
<span>
|
|
= 'default' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_DEFAULT_FONT_NAME">DEFAULT_FONT_NAME</a>
|
|
<span>
|
|
= 'Arial' </span>
|
|
</dt>
|
|
<dd>Default font settings.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_DEFAULT_FONT_SIZE">DEFAULT_FONT_SIZE</a>
|
|
<span>
|
|
= 10 </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_DEFAULT_PAPER">DEFAULT_PAPER</a>
|
|
<span>
|
|
= 'A4' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_OLD_LIB">OLD_LIB</a>
|
|
<span>
|
|
= PhpOfficePhpWordSharedZipArchive::class </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_PCLZIP">PCLZIP</a>
|
|
<span>
|
|
= 'PclZip' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_PDF_RENDERER_DOMPDF">PDF_RENDERER_DOMPDF</a>
|
|
<span>
|
|
= 'DomPDF' </span>
|
|
</dt>
|
|
<dd>PDF rendering libraries.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_PDF_RENDERER_MPDF">PDF_RENDERER_MPDF</a>
|
|
<span>
|
|
= 'MPDF' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_PDF_RENDERER_TCPDF">PDF_RENDERER_TCPDF</a>
|
|
<span>
|
|
= 'TCPDF' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_CM">UNIT_CM</a>
|
|
<span>
|
|
= 'cm' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_INCH">UNIT_INCH</a>
|
|
<span>
|
|
= 'inch' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_MM">UNIT_MM</a>
|
|
<span>
|
|
= 'mm' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_PICA">UNIT_PICA</a>
|
|
<span>
|
|
= 'pica' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_POINT">UNIT_POINT</a>
|
|
<span>
|
|
= 'point' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_TWIP">UNIT_TWIP</a>
|
|
<span>
|
|
= 'twip' </span>
|
|
</dt>
|
|
<dd>Measurement units multiplication factor.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_ZIPARCHIVE">ZIPARCHIVE</a>
|
|
<span>
|
|
= 'ZipArchive' </span>
|
|
</dt>
|
|
<dd>Zip libraries.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_defaultFontName">$defaultFontName</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Default font name.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_defaultFontSize">$defaultFontSize</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Default font size.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_defaultPaper">$defaultPaper</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Default paper.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_measurementUnit">$measurementUnit</a>
|
|
<span>
|
|
: float|int </span>
|
|
</dt>
|
|
<dd>Measurement unit.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_outputEscapingEnabled">$outputEscapingEnabled</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Enables built-in output escaping mechanism.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_pdfRendererName">$pdfRendererName</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Name of the external Library used for rendering PDF files.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_pdfRendererPath">$pdfRendererPath</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Directory Path to the external Library used for rendering PDF files.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_tempDir">$tempDir</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>The user defined temporary directory.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_xmlWriterCompatibility">$xmlWriterCompatibility</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Compatibility option for XMLWriter.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_zipClass">$zipClass</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Name of the class used for Zip file management.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getDefaultFontName">getDefaultFontName()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Get default font name.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getDefaultFontSize">getDefaultFontSize()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Get default font size.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getDefaultPaper">getDefaultPaper()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Get default paper.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getMeasurementUnit">getMeasurementUnit()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Get measurement unit.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getPdfRendererName">getPdfRendererName()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Return the PDF Rendering Library.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getPdfRendererPath">getPdfRendererPath()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Return the directory path to the PDF Rendering Library.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getTempDir">getTempDir()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Returns path to temporary directory.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getZipClass">getZipClass()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Get zip handler class.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_hasCompatibility">hasCompatibility()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Return the compatibility option used by the XMLWriter.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_isOutputEscapingEnabled">isOutputEscapingEnabled()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_loadConfig">loadConfig()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Load setting from phpword.yml or phpword.yml.dist.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setCompatibility">setCompatibility()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Set the compatibility option used by the XMLWriter.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setDefaultFontName">setDefaultFontName()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Set default font name.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setDefaultFontSize">setDefaultFontSize()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Set default font size.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setDefaultPaper">setDefaultPaper()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Set default paper.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setMeasurementUnit">setMeasurementUnit()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Set measurement unit.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setOutputEscapingEnabled">setOutputEscapingEnabled()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setPdfRenderer">setPdfRenderer()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Set details of the external library for rendering PDF files.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setPdfRendererName">setPdfRendererName()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Identify the external library to use for rendering PDF files.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setPdfRendererPath">setPdfRendererPath()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Location of external library to use for rendering PDF files.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setTempDir">setTempDir()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Sets the user defined path to temporary directory.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setZipClass">setZipClass()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Set zip handler class.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-constants">
|
|
<h3 class="phpdocumentor-elements__header" id="constants">
|
|
Constants
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_FONT_COLOR">
|
|
DEFAULT_FONT_COLOR
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">71</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<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">'000000'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_FONT_CONTENT_TYPE">
|
|
DEFAULT_FONT_CONTENT_TYPE
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">72</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<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">'default'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_FONT_NAME">
|
|
DEFAULT_FONT_NAME
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">69</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Default font settings.</p>
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<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">'Arial'</span>
|
|
</code>
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>OOXML defined font size values in halfpoints, i.e. twice of what PhpWord
|
|
use, and the conversion will be conducted during XML writing.</p>
|
|
</section>
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_FONT_SIZE">
|
|
DEFAULT_FONT_SIZE
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">70</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<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">10</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_PAPER">
|
|
DEFAULT_PAPER
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_DEFAULT_PAPER" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">73</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">DEFAULT_PAPER</span>
|
|
= <span class="phpdocumentor-signature__default-value">'A4'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_OLD_LIB">
|
|
OLD_LIB
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_OLD_LIB" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">34</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">OLD_LIB</span>
|
|
= <span class="phpdocumentor-signature__default-value">PhpOfficePhpWordSharedZipArchive::class</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_PCLZIP">
|
|
PCLZIP
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_PCLZIP" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">33</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">PCLZIP</span>
|
|
= <span class="phpdocumentor-signature__default-value">'PclZip'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_PDF_RENDERER_DOMPDF">
|
|
PDF_RENDERER_DOMPDF
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_PDF_RENDERER_DOMPDF" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">41</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">PDF rendering libraries.</p>
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">PDF_RENDERER_DOMPDF</span>
|
|
= <span class="phpdocumentor-signature__default-value">'DomPDF'</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">const</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>string</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_PDF_RENDERER_MPDF">
|
|
PDF_RENDERER_MPDF
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_PDF_RENDERER_MPDF" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">43</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">PDF_RENDERER_MPDF</span>
|
|
= <span class="phpdocumentor-signature__default-value">'MPDF'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_PDF_RENDERER_TCPDF">
|
|
PDF_RENDERER_TCPDF
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_PDF_RENDERER_TCPDF" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">42</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">PDF_RENDERER_TCPDF</span>
|
|
= <span class="phpdocumentor-signature__default-value">'TCPDF'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_UNIT_CM">
|
|
UNIT_CM
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_CM" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">57</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">UNIT_CM</span>
|
|
= <span class="phpdocumentor-signature__default-value">'cm'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_UNIT_INCH">
|
|
UNIT_INCH
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_INCH" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">59</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">UNIT_INCH</span>
|
|
= <span class="phpdocumentor-signature__default-value">'inch'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_UNIT_MM">
|
|
UNIT_MM
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_MM" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">58</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">UNIT_MM</span>
|
|
= <span class="phpdocumentor-signature__default-value">'mm'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_UNIT_PICA">
|
|
UNIT_PICA
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_PICA" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">61</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">UNIT_PICA</span>
|
|
= <span class="phpdocumentor-signature__default-value">'pica'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_UNIT_POINT">
|
|
UNIT_POINT
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_POINT" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">60</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">UNIT_POINT</span>
|
|
= <span class="phpdocumentor-signature__default-value">'point'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_UNIT_TWIP">
|
|
UNIT_TWIP
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_UNIT_TWIP" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">56</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Measurement units multiplication factor.</p>
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">UNIT_TWIP</span>
|
|
= <span class="phpdocumentor-signature__default-value">'twip'</span>
|
|
</code>
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Applied to:</p>
|
|
<ul>
|
|
<li>Section: margins, header/footer height, gutter, column spacing</li>
|
|
<li>Tab: position</li>
|
|
<li>Indentation: left, right, firstLine, hanging</li>
|
|
<li>Spacing: before, after</li>
|
|
</ul>
|
|
</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">const</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>string</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_ZIPARCHIVE">
|
|
ZIPARCHIVE
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#constant_ZIPARCHIVE" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">32</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Zip libraries.</p>
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">ZIPARCHIVE</span>
|
|
= <span class="phpdocumentor-signature__default-value">'ZipArchive'</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">const</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>string</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_defaultFontName">
|
|
$defaultFontName
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_defaultFontName" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">115</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Default font name.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$defaultFontName</span>
|
|
= <span class="phpdocumentor-signature__default-value">self::DEFAULT_FONT_NAME</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_defaultFontSize">
|
|
$defaultFontSize
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_defaultFontSize" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">122</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Default font size.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$defaultFontSize</span>
|
|
= <span class="phpdocumentor-signature__default-value">self::DEFAULT_FONT_SIZE</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_defaultPaper">
|
|
$defaultPaper
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_defaultPaper" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">129</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Default paper.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$defaultPaper</span>
|
|
= <span class="phpdocumentor-signature__default-value">self::DEFAULT_PAPER</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_measurementUnit">
|
|
$measurementUnit
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_measurementUnit" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">108</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Measurement unit.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">float|int</span>
|
|
<span class="phpdocumentor-signature__name">$measurementUnit</span>
|
|
= <span class="phpdocumentor-signature__default-value">self::UNIT_TWIP</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_outputEscapingEnabled">
|
|
$outputEscapingEnabled
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_outputEscapingEnabled" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">144</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Enables built-in output escaping mechanism.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$outputEscapingEnabled</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>Default value is <code class="prettyprint">false</code> for backward compatibility with versions below 0.13.0.</p>
|
|
</section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_pdfRendererName">
|
|
$pdfRendererName
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_pdfRendererName" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">94</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Name of the external Library used for rendering PDF files.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$pdfRendererName</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_pdfRendererPath">
|
|
$pdfRendererPath
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_pdfRendererPath" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">101</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Directory Path to the external Library used for rendering PDF files.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$pdfRendererPath</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_tempDir">
|
|
$tempDir
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">136</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The user defined temporary directory.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$tempDir</span>
|
|
= <span class="phpdocumentor-signature__default-value">''</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_xmlWriterCompatibility">
|
|
$xmlWriterCompatibility
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_xmlWriterCompatibility" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">80</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Compatibility option for XMLWriter.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$xmlWriterCompatibility</span>
|
|
= <span class="phpdocumentor-signature__default-value">true</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_zipClass">
|
|
$zipClass
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#property_zipClass" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">87</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Name of the class used for Zip file management.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$zipClass</span>
|
|
= <span class="phpdocumentor-signature__default-value">self::ZIPARCHIVE</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-Settings.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getDefaultFontName">
|
|
getDefaultFontName()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">357</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__static">static</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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getDefaultFontSize">
|
|
getDefaultFontSize()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">385</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__static">static</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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getDefaultPaper">
|
|
getDefaultPaper()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getDefaultPaper" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">461</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get default paper.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getDefaultPaper</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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getMeasurementUnit">
|
|
getMeasurementUnit()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getMeasurementUnit" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">278</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get measurement unit.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getMeasurementUnit</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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getPdfRendererName">
|
|
getPdfRendererName()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getPdfRendererName" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">223</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Return the PDF Rendering Library.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getPdfRendererName</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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getPdfRendererPath">
|
|
getPdfRendererPath()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getPdfRendererPath" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">251</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Return the directory path to the PDF Rendering Library.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getPdfRendererPath</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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getTempDir">
|
|
getTempDir()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">321</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns path to temporary directory.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</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-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">string</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getZipClass">
|
|
getZipClass()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_getZipClass" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">178</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get zip handler class.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getZipClass</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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_hasCompatibility">
|
|
hasCompatibility()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_hasCompatibility" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">151</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Return the compatibility option used by the XMLWriter.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">hasCompatibility</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>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Compatibility</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_isOutputEscapingEnabled">
|
|
isOutputEscapingEnabled()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_isOutputEscapingEnabled" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">337</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">isOutputEscapingEnabled</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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.13.0</span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_loadConfig">
|
|
loadConfig()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_loadConfig" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">416</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Load setting from phpword.yml or phpword.yml.dist.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">loadConfig</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string </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">array<string|int, 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">$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>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setCompatibility">
|
|
setCompatibility()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setCompatibility" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">165</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set the compatibility option used by the XMLWriter.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setCompatibility</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$compatibility</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>This sets the setIndent and setIndentString for better compatibility</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">$compatibility</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setDefaultFontName">
|
|
setDefaultFontName()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">369</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__static">static</span> <span class="phpdocumentor-signature__name">setDefaultFontName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$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">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setDefaultFontSize">
|
|
setDefaultFontSize()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">397</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__static">static</span> <span class="phpdocumentor-signature__name">setDefaultFontSize</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$value</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">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setDefaultPaper">
|
|
setDefaultPaper()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setDefaultPaper" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">473</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set default paper.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setDefaultPaper</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$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">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setMeasurementUnit">
|
|
setMeasurementUnit()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setMeasurementUnit" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">290</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set measurement unit.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setMeasurementUnit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$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">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setOutputEscapingEnabled">
|
|
setOutputEscapingEnabled()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setOutputEscapingEnabled" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">347</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setOutputEscapingEnabled</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$outputEscapingEnabled</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$outputEscapingEnabled</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</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.13.0</span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setPdfRenderer">
|
|
setPdfRenderer()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setPdfRenderer" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">209</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set details of the external library for rendering PDF files.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setPdfRenderer</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$libraryName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$libraryBaseDir</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$libraryName</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">$libraryBaseDir</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">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Success or failure</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setPdfRendererName">
|
|
setPdfRendererName()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setPdfRendererName" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">235</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Identify the external library to use for rendering PDF files.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setPdfRendererName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$libraryName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$libraryName</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">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setPdfRendererPath">
|
|
setPdfRendererPath()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setPdfRendererPath" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">263</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Location of external library to use for rendering PDF files.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setPdfRendererPath</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$libraryBaseDir</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$libraryBaseDir</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Directory path to the library's base folder</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Success or failure</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setTempDir">
|
|
setTempDir()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">309</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets the user defined path to temporary directory.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setTempDir</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$tempDir</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$tempDir</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The user defined path to temporary directory</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">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">void</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setZipClass">
|
|
setZipClass()
|
|
<a href="classes/PhpOffice-PhpWord-Settings.html#method_setZipClass" 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/Settings.php"><a href="files/src-phpword-settings.html"><abbr title="src/PhpWord/Settings.php">Settings.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">190</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set zip handler class.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setZipClass</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$zipClass</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$zipClass</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">bool</span>
|
|
—
|
|
<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-Settings.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
</body>
|
|
</html>
|