<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Extract the contents of a phar archive to a directory</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.delete.html">Phar::delete</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.getmetadata.html">Phar::getMetadata</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phar.extractto" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::extractTo</h1>
<p class="verinfo">(Unknown)</p><p class="refpurpose"><span class="refname">Phar::extractTo</span> — <span class="dc-title">Extract the contents of a phar archive to a directory</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.extractto-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Phar::extractTo</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$pathto</code></span>
[, <span class="methodparam"><span class="type"><span class="type string|array">string|array</span></span> <code class="parameter">$files</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$overwrite</code><span class="initializer"> = false</span></span>
]] )</div>
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">This
method requires the <var class="filename">php.ini</var> setting <em>phar.readonly</em> to be
set to <em>0</em> in order to work for <a href="class.phar.html" class="classname">Phar</a>
objects. Otherwise, a <a href="class.pharexception.html" class="classname">PharException</a> will be thrown.</p></p></blockquote>
<p class="para">
Extract all files within a phar archive to disk. Extracted files and directories preserve
permissions as stored in the archive. The optional parameters allow optional control over
which files are extracted, and whether existing files on disk can be overwritten.
The second parameter <em>files</em> can be either the name of a file or
directory to extract, or an array of names of files and directories to extract. By
default, this method will not overwrite existing files, the third parameter can be
set to true to enable overwriting of files.
This method is similar to <span class="function"><a href="ziparchive.extractto.html" class="function">ZipArchive::extractTo()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.extractto-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">pathto</code></em></span>
<dd>
<p class="para">
Path within an archive to the file to delete.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">files</code></em></span>
<dd>
<p class="para">
The name of a file or directory to extract, or an array of files/directories to extract
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">overwrite</code></em></span>
<dd>
<p class="para">
Set to <strong><code>TRUE</code></strong> to enable overwriting existing files
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.extractto-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
returns <strong><code>TRUE</code></strong> on success, but it is better to check for thrown exception,
and assume success if none is thrown.
</p>
</div>
<div class="refsect1 errors" id="refsect1-phar.extractto-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.pharexception.html" class="classname">PharException</a> if errors occur while flushing
changes to disk.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.extractto-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-679">
<p><strong>Example #1 A <span class="function"><strong>Phar::extractTo()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">try {<br /> </span><span style="color: #0000BB">$phar </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'myphar.phar'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">extractTo</span><span style="color: #007700">(</span><span style="color: #DD0000">'/full/path'</span><span style="color: #007700">); </span><span style="color: #FF8000">// extract all files<br /> </span><span style="color: #0000BB">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">extractTo</span><span style="color: #007700">(</span><span style="color: #DD0000">'/another/path'</span><span style="color: #007700">, </span><span style="color: #DD0000">'file.txt'</span><span style="color: #007700">); </span><span style="color: #FF8000">// extract only file.txt<br /> </span><span style="color: #0000BB">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">extractTo</span><span style="color: #007700">(</span><span style="color: #DD0000">'/this/path'</span><span style="color: #007700">,<br /> array(</span><span style="color: #DD0000">'file1.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'file2.txt'</span><span style="color: #007700">)); </span><span style="color: #FF8000">// extract 2 files only<br /> </span><span style="color: #0000BB">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">extractTo</span><span style="color: #007700">(</span><span style="color: #DD0000">'/third/path'</span><span style="color: #007700">, </span><span style="color: #0000BB">null</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">); </span><span style="color: #FF8000">// extract all files, and overwrite<br /></span><span style="color: #007700">} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// handle errors<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.extractto-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phardata.extractto.html" class="function" rel="rdfs-seeAlso">PharData::extractTo()</a> - Extract the contents of a tar/zip archive to a directory</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.delete.html">Phar::delete</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.getmetadata.html">Phar::getMetadata</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
