📄 class.phar.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>The Phar class</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.fileformat.signature.html">Phar Signature format</a></div> <div class="next" style="text-align: right; float: right;"><a href="phar.addemptydir.html">Phar::addEmptyDir</a></div> <div class="up"><a href="book.phar.html">Phar</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div> <h1 class="title">The Phar class</h1> <div class="partintro"> <div id="Phar.intro" class="section"> <h2 class="title">Introduction</h2> <p class="para"> The Phar class provides a high-level interface to accessing and creating phar archives. </p> </div> <div id="Phar.synopsis" class="section"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"><b class="classname">Phar</b></div> <div class="classsynopsisinfo"> <span class="ooclass"> <b class="classname">Phar</b> </span> <span class="ooclass"> <span class="modifier">extends</span> <a href="class.directoryiterator.html" class="classname">DirectoryIterator</a> </span> <span class="oointerface">implements <span class="interfacename">Countable</span> </span> <span class="oointerface">, <span class="interfacename">ArrayAccess</span> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.addemptydir.html" class="function">Phar::addEmptyDir</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$dirname</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.addfile.html" class="function">Phar::addFile</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$file</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$localname</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.addfromstring.html" class="function">Phar::addFromString</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$localname</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$contents</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><a href="phar.apiversion.html" class="function">Phar::apiVersion</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><b><a href="phar.buildfromdirectory.html" class="function">Phar::buildFromDirectory</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$base_dir</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$regex</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><b><a href="phar.buildfromiterator.html" class="function">Phar::buildFromIterator</a></b></span> ( <span class="methodparam"><span class="type"><span class="type Iterator">Iterator</span></span> <tt class="parameter">$iter</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$base_directory</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.cancompress.html" class="function">Phar::canCompress</a></b></span> ([ <span class="methodparam"><span class="type">int</span> <tt class="parameter">$type</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.canwrite.html" class="function">Phar::canWrite</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="phar.compress.html" class="function">Phar::compress</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$compression</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$extension</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.compressallfilesbzip2.html" class="function">Phar::compressAllFilesBZIP2</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.compressallfilesgz.html" class="function">Phar::compressAllFilesGZ</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.compressfiles.html" class="function">Phar::compressFiles</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$compression</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phar.construct.html" class="function">Phar::__construct</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fname</tt></span> [, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$flags</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$alias</tt></span> ]] )</div><div class="methodsynopsis dc-description"> <span class="type">PharData</span> <span class="methodname"><b><a href="phar.converttodata.html" class="function">Phar::convertToData</a></b></span> ([ <span class="methodparam"><span class="type">int</span> <tt class="parameter">$format</tt></span> [, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$compression</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$extension</tt></span> ]]] )</div><div class="methodsynopsis dc-description"> <span class="type">Phar</span> <span class="methodname"><b><a href="phar.converttoexecutable.html" class="function">Phar::convertToExecutable</a></b></span> ([ <span class="methodparam"><span class="type">int</span> <tt class="parameter">$format</tt></span> [, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$compression</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$extension</tt></span> ]]] )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.copy.html" class="function">Phar::copy</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$oldfile</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$newfile</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><a href="phar.count.html" class="function">Phar::count</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><a href="phar.createdefaultstub.html" class="function">Phar::createDefaultStub</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="phar.decompress.html" class="function">Phar::decompress</a></b></span> ([ <span class="methodparam"><span class="type">string</span> <tt class="parameter">$extension</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.decompressfiles.html" class="function">Phar::decompressFiles</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><a href="phar.delmetadata.html" class="function">Phar::delMetadata</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><a href="phar.delete.html" class="function">Phar::delete</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$entry</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><a href="phar.extractto.html" class="function">Phar::extractTo</a></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><div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><a href="phar.getmetadata.html" class="function">Phar::getMetaData</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.getmodified.html" class="function">Phar::getModified</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><b><a href="phar.getsignature.html" class="function">Phar::getSignature</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><a href="phar.getstub.html" class="function">Phar::getStub</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><b><a href="phar.getsupportedcompression.html" class="function">Phar::getSupportedCompression</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><b><a href="phar.getsupportedsignatures.html" class="function">Phar::getSupportedSignatures</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><a href="phar.getversion.html" class="function">Phar::getVersion</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><a href="phar.hasmetadata.html" class="function">Phar::hasMetadata</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phar.interceptfilefuncs.html" class="function">Phar::interceptFileFuncs</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.isbuffering.html" class="function">Phar::isBuffering</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">mixed</span> <span class="methodname"><b><a href="phar.iscompressed.html" class="function">Phar::isCompressed</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.isfileformat.html" class="function">Phar::isFileFormat</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$format</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.isvalidpharfilename.html" class="function">Phar::isValidPharFilename</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$filename</tt></span> [, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$executable</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.iswritable.html" class="function">Phar::isWritable</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">mixed</span> <span class="methodname"><b><a href="phar.loadphar.html" class="function">Phar::loadPhar</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$filename</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$alias</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">mixed</span> <span class="methodname"><b><a href="phar.mapphar.html" class="function">Phar::mapPhar</a></b></span> ([ <span class="methodparam"><span class="type">string</span> <tt class="parameter">$alias</tt></span> [, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$dataoffset</tt></span> ]] )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phar.mount.html" class="function">Phar::mount</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pharpath</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$externalpath</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phar.mungserver.html" class="function">Phar::mungServer</a></b></span> ( <span class="methodparam"><span class="type">array</span> <tt class="parameter">$munglist</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.offsetexists.html" class="function">Phar::offsetExists</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$offset</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><a href="phar.offsetget.html" class="function">Phar::offsetGet</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$offset</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phar.offsetset.html" class="function">Phar::offsetSet</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$offset</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$value</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.offsetunset.html" class="function">Phar::offsetUnset</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$offset</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.running.html" class="function">Phar::running</a></b></span> ([ <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$retphar</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.setalias.html" class="function">Phar::setAlias</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$alias</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phar.setdefaultstub.html" class="function">Phar::setDefaultStub</a></b></span> ([ <span class="methodparam"><span class="type">string</span> <tt class="parameter">$index</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$webindex</tt></span> ]] )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phardata.setmetadata.html" class="function">Phar::setMetadata</a></b></span> ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$metadata</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><b><a href="phardata.setsignaturealgorithm.html" class="function">Phar::setSignatureAlgorithm</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$sigtype</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$privatekey</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phar.setstub.html" class="function">Phar::setStub</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$stub</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phar.startbuffering.html" class="function">Phar::startBuffering</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phar.stopbuffering.html" class="function">Phar::stopBuffering</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.uncompressallfiles.html" class="function">Phar::uncompressAllFiles</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="phar.unlinkarchive.html" class="function">Phar::unlinkArchive</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$archive</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="phar.webphar.html" class="function">Phar::webPhar</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$alias</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$index</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$f404</tt></span> , <span class="methodparam"><span class="type">array</span> <tt class="parameter">$mimetypes</tt></span> , <span class="methodparam"><span class="type">array</span> <tt class="parameter">$rewrites</tt></span> )</div> }</div> </div> </div> ⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -