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

1393 lines
68 KiB
HTML
Raw Permalink Normal View History

deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/phpoffice.html"><abbr title="\PhpOffice">PhpOffice</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/phpoffice-phpword.html"><abbr title="\PhpOffice\PhpWord">PhpWord</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice.html">PhpOffice</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword.html">PhpWord</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-shared.html">Shared</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
ZipArchive
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">38</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">ZipArchive wrapper.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"><p>Wraps zip archive functionality of PHP ZipArchive and PCLZip. PHP ZipArchive
properties and methods are bypassed and used as the model for the PCLZip
emulation. Only needed PHP ZipArchive features are implemented.</p>
</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.10.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-Shared-ZipArchive.html#constant_CREATE">CREATE</a>
<span>
&nbsp;= 1 </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#constant_OVERWRITE">OVERWRITE</a>
<span>
&nbsp;= 8 </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#property_filename">$filename</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Archive filename (emulate ZipArchive::$filename).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#property_numFiles">$numFiles</a>
<span>
&nbsp;: int </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Number of files (emulate ZipArchive::$numFiles).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#property_tempDir">$tempDir</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Temporary storage directory.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#property_usePclzip">$usePclzip</a>
<span>
&nbsp;: bool </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Use PCLZip (default behaviour).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#property_zip">$zip</a>
<span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
&nbsp;: <a href="classes/PclZip.html"><abbr title="\PclZip">PclZip</abbr></a>|<abbr title="\ZipArchive">ZipArchive</abbr> </span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Internal zip archive object.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method___call">__call()</a>
<span>
&nbsp;: mixed </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Catch function calls: pass to ZipArchive or PCLZip.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Create new instance.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_addFile">addFile()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_addFromString">addFromString()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_close">close()</a>
<span>
&nbsp;: bool </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Close the active archive.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_extractTo">extractTo()</a>
<span>
&nbsp;: bool </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Extract the archive contents (emulate \ZipArchive).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_getFromName">getFromName()</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Extract file from archive by given file name (emulate \ZipArchive).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_getNameIndex">getNameIndex()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_locateName">locateName()</a>
<span>
&nbsp;: <a href=""><abbr title=""></abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_open">open()</a>
<span>
&nbsp;: bool </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Open a new zip archive.</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipAddFile">pclzipAddFile()</a>
<span>
&nbsp;: bool </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Add a new file to the zip archive (emulate \ZipArchive).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipAddFromString">pclzipAddFromString()</a>
<span>
&nbsp;: bool </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Add a new file to the zip archive from a string of raw data (emulate \ZipArchive).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipExtractTo">pclzipExtractTo()</a>
<span>
&nbsp;: bool </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Extract the archive contents (emulate \ZipArchive).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipGetFromName">pclzipGetFromName()</a>
<span>
&nbsp;: string </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Extract file from archive by given file name (emulate \ZipArchive).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipGetNameIndex">pclzipGetNameIndex()</a>
<span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
&nbsp;: bool|string </span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Returns the name of an entry using its index (emulate \ZipArchive).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipLocateName">pclzipLocateName()</a>
<span>
&nbsp;: int </span>
</dt>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<dd>Returns the index of the entry in the archive (emulate \ZipArchive).</dd>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.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_CREATE">
CREATE
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#constant_CREATE" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">41</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</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">CREATE</span>
= <span class="phpdocumentor-signature__default-value">1</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>int Flags for open method</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_OVERWRITE">
OVERWRITE
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#constant_OVERWRITE" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">42</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</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">OVERWRITE</span>
= <span class="phpdocumentor-signature__default-value">8</span>
</code>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_filename">
$filename
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#property_filename" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">56</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Archive filename (emulate ZipArchive::$filename).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$filename</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_numFiles">
$numFiles
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#property_numFiles" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">49</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Number of files (emulate ZipArchive::$numFiles).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$numFiles</span>
= <span class="phpdocumentor-signature__default-value">0</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_tempDir">
$tempDir
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">63</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Temporary storage directory.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$tempDir</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_usePclzip">
$usePclzip
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#property_usePclzip" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">77</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Use PCLZip (default behaviour).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$usePclzip</span>
= <span class="phpdocumentor-signature__default-value">true</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_zip">
$zip
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#property_zip" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">70</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Internal zip archive object.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__type"><a href="classes/PclZip.html"><abbr title="\PclZip">PclZip</abbr></a>|<abbr title="\ZipArchive">ZipArchive</abbr></span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<span class="phpdocumentor-signature__name">$zip</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-Shared-ZipArchive.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___call">
__call()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method___call" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">103</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Catch function calls: pass to ZipArchive or PCLZip.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$function</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p><code class="prettyprint">call_user_func_array</code> can only used for public function, hence the <code class="prettyprint">public</code> in all <code class="prettyprint">pcl...</code> methods</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">$function</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$args</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">82</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Create new instance.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addFile">
addFile()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_addFile" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filename</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$localname = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$filename</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$localname = null</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_addFromString">
addFromString()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_addFromString" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">addFromString</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$localname</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$contents</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$localname</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contents</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_close">
close()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_close" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">168</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Close the active archive.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">close</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">codeCoverageIgnore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Can't find any test case. Uncomment when found.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_extractTo">
extractTo()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_extractTo" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">189</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Extract the archive contents (emulate \ZipArchive).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">extractTo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$destination</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$entries</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">bool</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$destination</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">$entries</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|string</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<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.10.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>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getFromName">
getFromName()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_getFromName" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">209</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Extract file from archive by given file name (emulate \ZipArchive).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getFromName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filename</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$filename</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Filename for the file in zip archive</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>$contents File string contents</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getNameIndex">
getNameIndex()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_getNameIndex" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getNameIndex</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$index</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$index</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_locateName">
locateName()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_locateName" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">locateName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_open">
open()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_open" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">131</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Open a new zip archive.</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">open</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filename</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$flags</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">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">$filename</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The file name of the ZIP archive to open</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$flags</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The mode to use to open the archive</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_pclzipAddFile">
pclzipAddFile()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipAddFile" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">232</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Add a new file to the zip archive (emulate \ZipArchive).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">pclzipAddFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filename</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$localname</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">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">$filename</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Directory/Name of the file to add to the zip archive</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$localname</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"><p>Directory/Name of the file added to the zip</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_pclzipAddFromString">
pclzipAddFromString()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipAddFromString" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">284</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Add a new file to the zip archive from a string of raw data (emulate \ZipArchive).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">pclzipAddFromString</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$localname</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$contents</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">$localname</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Directory/Name of the file to add to the zip archive</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contents</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>String of data to add to the zip archive</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_pclzipExtractTo">
pclzipExtractTo()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipExtractTo" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">318</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Extract the archive contents (emulate \ZipArchive).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">pclzipExtractTo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$destination</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$entries</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">bool</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$destination</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">$entries</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|string</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<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.10.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>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_pclzipGetFromName">
pclzipGetFromName()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipGetFromName" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">352</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Extract file from archive by given file name (emulate \ZipArchive).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">pclzipGetFromName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filename</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$filename</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Filename for the file in zip archive</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>$contents File string contents</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_pclzipGetNameIndex">
pclzipGetNameIndex()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipGetNameIndex" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">382</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Returns the name of an entry using its index (emulate \ZipArchive).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__name">pclzipGetNameIndex</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$index</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool|string</span></code>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$index</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-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.10.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-signature__response_type">bool|string</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_pclzipLocateName">
pclzipLocateName()
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#method_pclzipLocateName" 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/Shared/ZipArchive.php"><a href="files/src-phpword-shared-ziparchive.html"><abbr title="src/PhpWord/Shared/ZipArchive.php">ZipArchive.php</abbr></a></abbr>
:
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<span class="phpdocumentor-element-found-in__line">401</span>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
</aside>
deploy: 8521612b39edeec9055d3688ad555342a40857dd
2022-11-15 20:28:31 +00:00
<p class="phpdocumentor-summary">Returns the index of the entry in the archive (emulate \ZipArchive).</p>
deploy: 06b90e39a36872c6ee73534e1a073f4b3132fc6a
2021-03-08 01:07:47 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">pclzipLocateName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filename</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$filename</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Filename for the file in zip archive</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/PhpOffice-PhpWord-Shared-ZipArchive.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>
Reference in New Issue Copy Permalink