<!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>The PharData class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.webphar.html">Phar::webPhar</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phardata.addemptydir.html">PharData::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 id="class.phardata" class="reference">
<h1 class="title">The PharData class</h1>
<div class="partintro"><p class="verinfo">(PHP >= 5.3.0, PECL phar >= 2.0.0)</p>
<div class="section" id="phardata.intro">
<h2 class="title">Introduction</h2>
<p class="para">
The PharData class provides a high-level interface to accessing and creating
non-executable tar and zip archives. Because these archives do not contain
a stub and cannot be executed by the phar extension, it is possible to create
and manipulate regular zip and tar files using the PharData class even if
<em>phar.readonly</em> php.ini setting is <em>1</em>.
</p>
</div>
<div class="section" id="phardata.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">PharData</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.phar.html" class="classname">Phar</a>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.addemptydir.html" class="methodname">addEmptyDir</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$dirname</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phar.addfile.html" class="methodname">Phar::addFile</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$file</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$localname</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.addfromstring.html" class="methodname">addFromString</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$localname</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$contents</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="phar.buildfromdirectory.html" class="methodname">Phar::buildFromDirectory</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$base_dir</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$regex</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><a href="phardata.buildfromiterator.html" class="methodname">buildFromIterator</a></span>
( <span class="methodparam"><span class="type"><a href="class.iterator.html" class="type Iterator">Iterator</a></span> <code class="parameter">$iter</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$base_directory</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><a href="phardata.compress.html" class="methodname">compress</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.compressfiles.html" class="methodname">compressFiles</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="methodname"><a href="phardata.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$fname</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$format</code><span class="initializer"> = <strong><code>Phar::TAR</code></strong></span></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">PharData</span> <span class="methodname"><a href="phardata.converttodata.html" class="methodname">convertToData</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$format</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension</code></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">Phar</span> <span class="methodname"><a href="phardata.converttoexecutable.html" class="methodname">convertToExecutable</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$format</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension</code></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.copy.html" class="methodname">copy</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$oldfile</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$newfile</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><a href="phardata.decompress.html" class="methodname">decompress</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.decompressfiles.html" class="methodname">decompressFiles</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.delmetadata.html" class="methodname">delMetadata</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.delete.html" class="methodname">delete</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$entry</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.extractto.html" class="methodname">extractTo</a></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>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.iswritable.html" class="methodname">isWritable</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">void</span> <span class="methodname"><a href="phardata.offsetset.html" class="methodname">offsetSet</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$offset</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.offsetunset.html" class="methodname">offsetUnset</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$offset</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.setalias.html" class="methodname">setAlias</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.setdefaultstub.html" class="methodname">setDefaultStub</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$index</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$webindex</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phardata.setmetadata.html" class="methodname">Phar::setMetadata</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$metadata</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phardata.setsignaturealgorithm.html" class="methodname">Phar::setSignatureAlgorithm</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$sigtype</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="phardata.setstub.html" class="methodname">setStub</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$stub</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$len</code><span class="initializer"> = -1</span></span>
] )</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phar.addemptydir.html" class="methodname">Phar::addEmptyDir</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$dirname</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phar.addfile.html" class="methodname">Phar::addFile</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$file</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$localname</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phar.addfromstring.html" class="methodname">Phar::addFromString</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$localname</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$contents</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">string</span> <span class="methodname"><a href="phar.apiversion.html" class="methodname">Phar::apiVersion</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="phar.buildfromdirectory.html" class="methodname">Phar::buildFromDirectory</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$base_dir</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$regex</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="phar.buildfromiterator.html" class="methodname">Phar::buildFromIterator</a></span>
( <span class="methodparam"><span class="type"><a href="class.iterator.html" class="type Iterator">Iterator</a></span> <code class="parameter">$iter</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$base_directory</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><a href="phar.cancompress.html" class="methodname">Phar::canCompress</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code><span class="initializer"> = 0</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><a href="phar.canwrite.html" class="methodname">Phar::canWrite</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">object</span> <span class="methodname"><a href="phar.compress.html" class="methodname">Phar::compress</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.compressallfilesbzip2.html" class="methodname">Phar::compressAllFilesBZIP2</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.compressallfilesgz.html" class="methodname">Phar::compressAllFilesGZ</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phar.compressfiles.html" class="methodname">Phar::compressFiles</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="phar.construct.html" class="methodname">Phar::__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$fname</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">PharData</span> <span class="methodname"><a href="phar.converttodata.html" class="methodname">Phar::convertToData</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$format</code><span class="initializer"> = 9021976</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code><span class="initializer"> = 9021976</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension</code></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">Phar</span> <span class="methodname"><a href="phar.converttoexecutable.html" class="methodname">Phar::convertToExecutable</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$format</code><span class="initializer"> = 9021976</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code><span class="initializer"> = 9021976</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension</code></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.copy.html" class="methodname">Phar::copy</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$oldfile</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$newfile</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="phar.count.html" class="methodname">Phar::count</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">string</span> <span class="methodname"><a href="phar.createdefaultstub.html" class="methodname">Phar::createDefaultStub</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$indexfile</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$webindexfile</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">object</span> <span class="methodname"><a href="phar.decompress.html" class="methodname">Phar::decompress</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.decompressfiles.html" class="methodname">Phar::decompressFiles</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.delmetadata.html" class="methodname">Phar::delMetadata</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.delete.html" class="methodname">Phar::delete</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$entry</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.extractto.html" class="methodname">Phar::extractTo</a></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>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="phar.getmetadata.html" class="methodname">Phar::getMetadata</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.getmodified.html" class="methodname">Phar::getModified</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="phar.getsignature.html" class="methodname">Phar::getSignature</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="phar.getstub.html" class="methodname">Phar::getStub</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">array</span> <span class="methodname"><a href="phar.getsupportedcompression.html" class="methodname">Phar::getSupportedCompression</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">array</span> <span class="methodname"><a href="phar.getsupportedsignatures.html" class="methodname">Phar::getSupportedSignatures</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="phar.getversion.html" class="methodname">Phar::getVersion</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.hasmetadata.html" class="methodname">Phar::hasMetadata</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">void</span> <span class="methodname"><a href="phar.interceptfilefuncs.html" class="methodname">Phar::interceptFileFuncs</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.isbuffering.html" class="methodname">Phar::isBuffering</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="phar.iscompressed.html" class="methodname">Phar::isCompressed</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.isfileformat.html" class="methodname">Phar::isFileFormat</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$format</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><a href="phar.isvalidpharfilename.html" class="methodname">Phar::isValidPharFilename</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$executable</code><span class="initializer"> = true</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.iswritable.html" class="methodname">Phar::isWritable</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><a href="phar.loadphar.html" class="methodname">Phar::loadPhar</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><a href="phar.mapphar.html" class="methodname">Phar::mapPhar</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$dataoffset</code><span class="initializer"> = 0</span></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">void</span> <span class="methodname"><a href="phar.mount.html" class="methodname">Phar::mount</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$pharpath</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$externalpath</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">void</span> <span class="methodname"><a href="phar.mungserver.html" class="methodname">Phar::mungServer</a></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$munglist</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.offsetexists.html" class="methodname">Phar::offsetExists</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$offset</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="phar.offsetget.html" class="methodname">Phar::offsetGet</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$offset</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phar.offsetset.html" class="methodname">Phar::offsetSet</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$offset</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.offsetunset.html" class="methodname">Phar::offsetUnset</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$offset</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">string</span> <span class="methodname"><a href="phar.running.html" class="methodname">Phar::running</a></span>
([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$retphar</code><span class="initializer"> = true</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.setalias.html" class="methodname">Phar::setAlias</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.setdefaultstub.html" class="methodname">Phar::setDefaultStub</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$index</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$webindex</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phardata.setmetadata.html" class="methodname">Phar::setMetadata</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$metadata</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phardata.setsignaturealgorithm.html" class="methodname">Phar::setSignatureAlgorithm</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$sigtype</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$privatekey</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.setstub.html" class="methodname">Phar::setStub</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$stub</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$len</code><span class="initializer"> = -1</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phar.startbuffering.html" class="methodname">Phar::startBuffering</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="phar.stopbuffering.html" class="methodname">Phar::stopBuffering</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="phar.uncompressallfiles.html" class="methodname">Phar::uncompressAllFiles</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><a href="phar.unlinkarchive.html" class="methodname">Phar::unlinkArchive</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$archive</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">void</span> <span class="methodname"><a href="phar.webphar.html" class="methodname">Phar::webPhar</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$index</code><span class="initializer"> = "index.php"</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$f404</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$mimetypes</code></span>
[, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$rewrites</code></span>
]]]]] )</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="phardata.addemptydir.html">PharData::addEmptyDir</a> — Add an empty directory to the tar/zip archive</li><li><a href="phardata.addfile.html">PharData::addFile</a> — Add a file from the filesystem to the tar/zip archive</li><li><a href="phardata.addfromstring.html">PharData::addFromString</a> — Add a file from the filesystem to the tar/zip archive</li><li><a href="phardata.buildfromdirectory.html">PharData::buildFromDirectory</a> — Construct a tar/zip archive from the files within a directory.</li><li><a href="phardata.buildfromiterator.html">PharData::buildFromIterator</a> — Construct a tar or zip archive from an iterator.</li><li><a href="phardata.compress.html">PharData::compress</a> — Compresses the entire tar/zip archive using Gzip or Bzip2 compression</li><li><a href="phardata.compressfiles.html">PharData::compressFiles</a> — Compresses all files in the current tar/zip archive</li><li><a href="phardata.construct.html">PharData::__construct</a> — Construct a non-executable tar or zip archive object</li><li><a href="phardata.converttodata.html">PharData::convertToData</a> — Convert a phar archive to a non-executable tar or zip file</li><li><a href="phardata.converttoexecutable.html">PharData::convertToExecutable</a> — Convert a non-executable tar/zip archive to an executable phar archive</li><li><a href="phardata.copy.html">PharData::copy</a> — Copy a file internal to the phar archive to another new file within the phar</li><li><a href="phardata.decompress.html">PharData::decompress</a> — Decompresses the entire Phar archive</li><li><a href="phardata.decompressfiles.html">PharData::decompressFiles</a> — Decompresses all files in the current zip archive</li><li><a href="phardata.delmetadata.html">PharData::delMetadata</a> — Deletes the global metadata of a zip archive</li><li><a href="phardata.delete.html">PharData::delete</a> — Delete a file within a tar/zip archive</li><li><a href="phardata.extractto.html">PharData::extractTo</a> — Extract the contents of a tar/zip archive to a directory</li><li><a href="phardata.iswritable.html">PharData::isWritable</a> — Returns true if the tar/zip archive can be modified</li><li><a href="phardata.offsetset.html">PharData::offsetSet</a> — set the contents of a file within the tar/zip to those of an external file or string</li><li><a href="phardata.offsetunset.html">PharData::offsetUnset</a> — remove a file from a tar/zip archive</li><li><a href="phardata.setalias.html">PharData::setAlias</a> — dummy function (Phar::setAlias is not valid for PharData)</li><li><a href="phardata.setdefaultstub.html">PharData::setDefaultStub</a> — dummy function (Phar::setDefaultStub is not valid for PharData)</li><li><a href="phardata.setmetadata.html">Phar::setMetadata</a> — Sets phar archive meta-data</li><li><a href="phardata.setsignaturealgorithm.html">Phar::setSignatureAlgorithm</a> — set the signature algorithm for a phar and apply it. The</li><li><a href="phardata.setstub.html">PharData::setStub</a> — dummy function (Phar::setStub is not valid for PharData)</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.webphar.html">Phar::webPhar</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phardata.addemptydir.html">PharData::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></body></html>
