Source of: /manual/en/class.PharFileInfo.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.phar.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'class.PharFileInfo.php',
1 => 'PharFileInfo',
),
'up' =>
array (
0 => 'book.phar.php',
1 => 'Phar',
),
'prev' =>
array (
0 => 'phardata.setstub.php',
1 => 'PharData::setStub',
),
'next' =>
array (
0 => 'pharfileinfo.chmod.php',
1 => 'PharFileInfo::chmod',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div>
<h1 class="title">The PharFileInfo class</h1>
<div class="partintro">
<div id="PharFileInfo.intro" class="section">
<h2 class="title">Introduction</h2>
<p class="para">
The PharFileInfo class provides a high-level interface to the contents
and attributes of a single file within a phar archive.
</p>
</div>
<div id="PharFileInfo.synopsis" class="section">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"><b class="classname">PharFileInfo</b></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<b class="classname">PharFileInfo</b>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.splfileinfo.php" class="classname">SplFileInfo</a>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="type">void</span> <span class="methodname"><a href="pharfileinfo.chmod.php" class="function">chmod</a></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$permissions</tt></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.compress.php" class="function">compress</a></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"><a href="pharfileinfo.construct.php" class="function">__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$entry</tt></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.decompress.php" class="function">decompress</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.delmetadata.php" class="function">delMetadata</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="pharfileinfo.getcrc32.php" class="function">getCRC32</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="pharfileinfo.getcompressedsize.php" class="function">getCompressedSize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">mixed</span> <span class="methodname"><a href="pharfileinfo.getmetadata.php" class="function">getMetaData</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="pharfileinfo.getpharflags.php" class="function">getPharFlags</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.hasmetadata.php" class="function">hasMetadata</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.iscrcchecked.php" class="function">isCRCChecked</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.iscompressed.php" class="function">isCompressed</a></span>
([ <span class="methodparam"><span class="type">int</span> <tt class="parameter">$compression_type</tt><span class="initializer"> = 9021976</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.iscompressedbzip2.php" class="function">isCompressedBZIP2</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.iscompressedgz.php" class="function">isCompressedGZ</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.setcompressedbzip2.php" class="function">setCompressedBZIP2</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.setcompressedgz.php" class="function">setCompressedGZ</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">void</span> <span class="methodname"><a href="pharfileinfo.setmetadata.php" class="function">setMetaData</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$metadata</tt></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="pharfileinfo.setuncompressed.php" class="function">setUncompressed</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="pharfileinfo.chmod.php">PharFileInfo::chmod</a> — Sets file-specific permission bits</li><li><a href="pharfileinfo.compress.php">PharFileInfo::compress</a> — Compresses the current Phar entry with either zlib or bzip2 compression</li><li><a href="pharfileinfo.construct.php">PharFileInfo::__construct</a> — Construct a Phar entry object</li><li><a href="pharfileinfo.decompress.php">PharFileInfo::decompress</a> — Decompresses the current Phar entry within the phar</li><li><a href="pharfileinfo.delmetadata.php">PharFileInfo::delMetadata</a> — Deletes the metadata of the entry</li><li><a href="pharfileinfo.getcrc32.php">PharFileInfo::getCRC32</a> — Returns CRC32 code or throws an exception if CRC has not been verified</li><li><a href="pharfileinfo.getcompressedsize.php">PharFileInfo::getCompressedSize</a> — Returns the actual size of the file (with compression) inside the Phar archive</li><li><a href="pharfileinfo.getmetadata.php">PharFileInfo::getMetaData</a> — Returns file-specific meta-data saved with a file</li><li><a href="pharfileinfo.getpharflags.php">PharFileInfo::getPharFlags</a> — Returns the Phar file entry flags</li><li><a href="pharfileinfo.hasmetadata.php">PharFileInfo::hasMetadata</a> — Returns the metadata of the entry</li><li><a href="pharfileinfo.iscrcchecked.php">PharFileInfo::isCRCChecked</a> — Returns whether file entry has had its CRC verified</li><li><a href="pharfileinfo.iscompressed.php">PharFileInfo::isCompressed</a> — Returns whether the entry is compressed</li><li><a href="pharfileinfo.iscompressedbzip2.php">PharFileInfo::isCompressedBZIP2</a> — Returns whether the entry is compressed using bzip2</li><li><a href="pharfileinfo.iscompressedgz.php">PharFileInfo::isCompressedGZ</a> — Returns whether the entry is compressed using gz</li><li><a href="pharfileinfo.setcompressedbzip2.php">PharFileInfo::setCompressedBZIP2</a> — Compresses the current Phar entry within the phar using Bzip2 compression</li><li><a href="pharfileinfo.setcompressedgz.php">PharFileInfo::setCompressedGZ</a> — Compresses the current Phar entry within the phar using gz compression</li><li><a href="pharfileinfo.setmetadata.php">PharFileInfo::setMetaData</a> — Sets file-specific meta-data saved with a file</li><li><a href="pharfileinfo.setuncompressed.php">PharFileInfo::setUncompressed</a> — Uncompresses the current Phar entry within the phar, if it is compressed</li></ul>
</div>
<?php manual_footer(); ?>
