phar.extractto.html
来自「php的帮助文档,涉及到PHP的案例和基本语法,以及实际应用内容」· HTML 代码 · 共 151 行
HTML
151 行
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Extract the contents of a phar archive to a directory</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div 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">(No version information available, might be only in CVS)</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"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><b>Phar::extractTo</b></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pathto</tt></span> [, <span class="methodparam"><span class="type"><span class="type string|array">string|array</span></span> <tt class="parameter">$files</tt></span> [, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$overwrite</tt></span> ]] )</div> <blockquote><p><b class="note">Note</b>: Thismethod requires the <var class="filename">php.ini</var> setting <i>phar.readonly</i> to beset to <i>0</i> 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.<br /></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 <i>files</i> 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 <a href="function.ziparchive-extractto.html" class="function">ZipArchive::extractTo()</a>. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">pathto</tt></i></span> <dd> <p class="para"> Path within an archive to the file to delete. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">files</tt></i></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"><i><tt class="parameter">overwrite</tt></i></span> <dd> <p class="para"> <b><tt>FALSE</tt></b> by default, set to <b><tt>TRUE</tt></b> to enable overwriting existing files </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> returns <b><tt>TRUE</tt></b> on success, but it is better to check for thrown exception, and assume success if none is thrown. </p> </div> <div class="refsect1 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"> <h3 class="title">Examples</h3> <p class="para"> <div class="example"> <p><b>Example #1 A <b>Phar::extractTo()</b> example</b></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"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="phardata.extractto.html" class="function" rel="rdfs-seeAlso">PharData::extractTo()</a></li> </ul> </p> </div></div><hr /><div 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>⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?