mirror of
https://github.com/splitbrain/php-archive.git
synced 2025-07-10 09:26:32 +02:00
1437 lines
27 KiB
HTML
1437 lines
27 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<title>Class splitbrain\PHPArchive\FileInfo</title>
|
|
|
|
<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<div id="left">
|
|
<div id="menu">
|
|
<a href="index.html" title="Overview"><span>Overview</span></a>
|
|
|
|
|
|
<div id="groups">
|
|
<h3>Namespaces</h3>
|
|
<ul>
|
|
<li class="active">
|
|
<a href="namespace-splitbrain.html">
|
|
splitbrain<span></span>
|
|
</a>
|
|
|
|
<ul>
|
|
<li class="active">
|
|
<a href="namespace-splitbrain.PHPArchive.html">
|
|
PHPArchive </a>
|
|
|
|
</li>
|
|
</ul></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
|
|
<div id="elements">
|
|
<h3>Classes</h3>
|
|
<ul>
|
|
<li><a href="class-splitbrain.PHPArchive.Archive.html">Archive</a></li>
|
|
<li class="active"><a href="class-splitbrain.PHPArchive.FileInfo.html">FileInfo</a></li>
|
|
<li><a href="class-splitbrain.PHPArchive.Tar.html">Tar</a></li>
|
|
<li><a href="class-splitbrain.PHPArchive.Zip.html">Zip</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
<h3>Exceptions</h3>
|
|
<ul>
|
|
<li><a href="class-splitbrain.PHPArchive.ArchiveCorruptedException.html">ArchiveCorruptedException</a></li>
|
|
<li><a href="class-splitbrain.PHPArchive.ArchiveIllegalCompressionException.html">ArchiveIllegalCompressionException</a></li>
|
|
<li><a href="class-splitbrain.PHPArchive.ArchiveIOException.html">ArchiveIOException</a></li>
|
|
<li><a href="class-splitbrain.PHPArchive.FileInfoException.html">FileInfoException</a></li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="splitter"></div>
|
|
|
|
<div id="right">
|
|
<div id="rightInner">
|
|
<form id="search">
|
|
<input type="hidden" name="cx" value="">
|
|
<input type="hidden" name="ie" value="UTF-8">
|
|
<input type="text" name="q" class="text" placeholder="Search">
|
|
</form>
|
|
|
|
<div id="navigation">
|
|
<ul>
|
|
<li>
|
|
<a href="index.html" title="Overview"><span>Overview</span></a>
|
|
</li>
|
|
<li>
|
|
<a href="namespace-splitbrain.PHPArchive.html" title="Summary of splitbrain\PHPArchive"><span>Namespace</span></a>
|
|
</li>
|
|
<li class="active">
|
|
<span>Class</span> </li>
|
|
</ul>
|
|
<ul>
|
|
</ul>
|
|
<ul>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="content" class="class">
|
|
<h1>Class FileInfo</h1>
|
|
|
|
|
|
<div class="description">
|
|
<p>Class FileInfo</p>
|
|
|
|
<p>stores meta data about a file in an Archive</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="info">
|
|
|
|
|
|
<b>Namespace:</b> <a href="namespace-splitbrain.html">splitbrain</a>\<a href="namespace-splitbrain.PHPArchive.html">PHPArchive</a><br>
|
|
<b>Package:</b> splitbrain\PHPArchive<br>
|
|
|
|
<b>License:</b>
|
|
<a href="MIT">MIT</a><br>
|
|
<b>Author:</b>
|
|
Andreas Gohr <a href="mailto:andi@splitbrain.org">andi@splitbrain.org</a><br>
|
|
<b>Located at</b> <a href="source-class-splitbrain.PHPArchive.FileInfo.html#5-357" title="Go to source code">FileInfo.php</a>
|
|
<br>
|
|
</div>
|
|
|
|
|
|
|
|
<table class="summary methods" id="methods">
|
|
<caption>Methods summary</caption>
|
|
<tr data-order="__construct" id="___construct">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#___construct">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#29-38" title="Go to source code">__construct</a>( <span>string <var>$path</var> = <span class="php-quote">''</span></span> )</code>
|
|
|
|
<div class="description short">
|
|
<p>initialize dynamic defaults</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>initialize dynamic defaults</p>
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$path</var></dt>
|
|
<dd>The path of the file, can also be set later through setPath()</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="__call" id="___call">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
mixed
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#___call">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#40-56" title="Go to source code">__call</a>( <span>string <var>$name</var></span>, <span>array <var>$arguments</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
<p>Handle calls to deprecated methods</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>Handle calls to deprecated methods</p>
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$name</var></dt>
|
|
<dd></dd>
|
|
<dt><var>$arguments</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
mixed
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="fromPath" id="_fromPath">
|
|
|
|
<td class="attributes"><code>
|
|
public static
|
|
|
|
<code><a href="class-splitbrain.PHPArchive.FileInfo.html">splitbrain\PHPArchive\FileInfo</a></code>
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_fromPath">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#58-92" title="Go to source code">fromPath</a>( <span>string <var>$path</var></span>, <span>string <var>$as</var> = <span class="php-quote">''</span></span> )</code>
|
|
|
|
<div class="description short">
|
|
<p>Factory to build FileInfo from existing file or directory</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>Factory to build FileInfo from existing file or directory</p>
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$path</var></dt>
|
|
<dd>path to a file on the local file system</dd>
|
|
<dt><var>$as</var></dt>
|
|
<dd>optional path to use inside the archive</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
<code><a href="class-splitbrain.PHPArchive.FileInfo.html">splitbrain\PHPArchive\FileInfo</a></code>
|
|
</div>
|
|
|
|
<h4>Throws</h4>
|
|
<div class="list">
|
|
<code><a href="class-splitbrain.PHPArchive.FileInfoException.html">splitbrain\PHPArchive\FileInfoException</a></code>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getSize" id="_getSize">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getSize">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#94-101" title="Go to source code">getSize</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
integer<br>the filesize. always 0 for directories
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setSize" id="_setSize">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setSize">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#103-109" title="Go to source code">setSize</a>( <span>integer <var>$size</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$size</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getCompressedSize" id="_getCompressedSize">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getCompressedSize">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#111-117" title="Go to source code">getCompressedSize</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
integer
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setCompressedSize" id="_setCompressedSize">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setCompressedSize">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#119-125" title="Go to source code">setCompressedSize</a>( <span>integer <var>$csize</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$csize</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getMtime" id="_getMtime">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getMtime">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#127-133" title="Go to source code">getMtime</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
integer
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setMtime" id="_setMtime">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setMtime">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#135-141" title="Go to source code">setMtime</a>( <span>integer <var>$mtime</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$mtime</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getGid" id="_getGid">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getGid">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#143-149" title="Go to source code">getGid</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
integer
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setGid" id="_setGid">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setGid">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#151-157" title="Go to source code">setGid</a>( <span>integer <var>$gid</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$gid</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getUid" id="_getUid">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getUid">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#159-165" title="Go to source code">getUid</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
integer
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setUid" id="_setUid">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setUid">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#167-173" title="Go to source code">setUid</a>( <span>integer <var>$uid</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$uid</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getComment" id="_getComment">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getComment">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#175-181" title="Go to source code">getComment</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setComment" id="_setComment">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setComment">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#183-189" title="Go to source code">setComment</a>( <span>string <var>$comment</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$comment</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getGroup" id="_getGroup">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getGroup">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#191-197" title="Go to source code">getGroup</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setGroup" id="_setGroup">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setGroup">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#199-205" title="Go to source code">setGroup</a>( <span>string <var>$group</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$group</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getIsdir" id="_getIsdir">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
boolean
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getIsdir">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#207-213" title="Go to source code">getIsdir</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
boolean
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setIsdir" id="_setIsdir">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setIsdir">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#215-225" title="Go to source code">setIsdir</a>( <span>boolean <var>$isdir</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$isdir</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getMode" id="_getMode">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
integer
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getMode">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#227-233" title="Go to source code">getMode</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
integer
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setMode" id="_setMode">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setMode">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#235-241" title="Go to source code">setMode</a>( <span>integer <var>$mode</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$mode</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getOwner" id="_getOwner">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getOwner">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#243-249" title="Go to source code">getOwner</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setOwner" id="_setOwner">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setOwner">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#251-257" title="Go to source code">setOwner</a>( <span>string <var>$owner</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$owner</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="getPath" id="_getPath">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_getPath">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#259-265" title="Go to source code">getPath</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="setPath" id="_setPath">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_setPath">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#267-273" title="Go to source code">setPath</a>( <span>string <var>$path</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$path</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="cleanPath" id="_cleanPath">
|
|
|
|
<td class="attributes"><code>
|
|
protected
|
|
|
|
string
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_cleanPath">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#275-297" title="Go to source code">cleanPath</a>( <span>string <var>$path</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
<p>Cleans up a path and removes relative parts, also strips leading slashes</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>Cleans up a path and removes relative parts, also strips leading slashes</p>
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$path</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
string
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="strip" id="_strip">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_strip">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#299-334" title="Go to source code">strip</a>( <span>integer|string <var>$strip</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
<p>Strip given prefix or number of path segments from the filename</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>Strip given prefix or number of path segments from the filename</p>
|
|
|
|
<p>The $strip parameter allows you to strip a certain number of path components from the filenames
|
|
found in the tar file, similar to the --strip-components feature of GNU tar. This is triggered when
|
|
an integer is passed as $strip.
|
|
Alternatively a fixed string prefix may be passed in $strip. If the filename matches this prefix,
|
|
the prefix will be stripped. It is recommended to give prefixes with a trailing slash.</p>
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$strip</var></dt>
|
|
<dd></dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="matchExpression" id="_matchExpression">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
boolean
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_matchExpression">#</a>
|
|
<code><a href="source-class-splitbrain.PHPArchive.FileInfo.html#336-356" title="Go to source code">matchExpression</a>( <span>string <var>$include</var> = <span class="php-quote">''</span></span>, <span>string <var>$exclude</var> = <span class="php-quote">''</span></span> )</code>
|
|
|
|
<div class="description short">
|
|
<p>Does the file match the given include and exclude expressions?</p>
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
<p>Does the file match the given include and exclude expressions?</p>
|
|
|
|
<p>Exclude rules take precedence over include rules</p>
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$include</var></dt>
|
|
<dd>Regular expression of files to include</dd>
|
|
<dt><var>$exclude</var></dt>
|
|
<dd>Regular expression of files to exclude</dd>
|
|
</dl></div>
|
|
|
|
<h4>Returns</h4>
|
|
<div class="list">
|
|
boolean
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<table class="summary properties" id="properties">
|
|
<caption>Properties summary</caption>
|
|
<tr data-order="isdir" id="$isdir">
|
|
<td class="attributes"><code>
|
|
protected
|
|
boolean
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#17" title="Go to source code"><var>$isdir</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$isdir" class="anchor">#</a>
|
|
<code><span class="php-keyword1">false</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="path" id="$path">
|
|
<td class="attributes"><code>
|
|
protected
|
|
string
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#18" title="Go to source code"><var>$path</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$path" class="anchor">#</a>
|
|
<code><span class="php-quote">''</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="size" id="$size">
|
|
<td class="attributes"><code>
|
|
protected
|
|
integer
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#19" title="Go to source code"><var>$size</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$size" class="anchor">#</a>
|
|
<code><span class="php-num">0</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="csize" id="$csize">
|
|
<td class="attributes"><code>
|
|
protected
|
|
integer
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#20" title="Go to source code"><var>$csize</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$csize" class="anchor">#</a>
|
|
<code><span class="php-num">0</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="mtime" id="$mtime">
|
|
<td class="attributes"><code>
|
|
protected
|
|
integer
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#21" title="Go to source code"><var>$mtime</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$mtime" class="anchor">#</a>
|
|
<code><span class="php-num">0</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="mode" id="$mode">
|
|
<td class="attributes"><code>
|
|
protected
|
|
integer
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#22" title="Go to source code"><var>$mode</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$mode" class="anchor">#</a>
|
|
<code><span class="php-num">0664</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="owner" id="$owner">
|
|
<td class="attributes"><code>
|
|
protected
|
|
string
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#23" title="Go to source code"><var>$owner</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$owner" class="anchor">#</a>
|
|
<code><span class="php-quote">''</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="group" id="$group">
|
|
<td class="attributes"><code>
|
|
protected
|
|
string
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#24" title="Go to source code"><var>$group</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$group" class="anchor">#</a>
|
|
<code><span class="php-quote">''</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="uid" id="$uid">
|
|
<td class="attributes"><code>
|
|
protected
|
|
integer
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#25" title="Go to source code"><var>$uid</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$uid" class="anchor">#</a>
|
|
<code><span class="php-num">0</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="gid" id="$gid">
|
|
<td class="attributes"><code>
|
|
protected
|
|
integer
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#26" title="Go to source code"><var>$gid</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$gid" class="anchor">#</a>
|
|
<code><span class="php-num">0</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr data-order="comment" id="$comment">
|
|
<td class="attributes"><code>
|
|
protected
|
|
string
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-splitbrain.PHPArchive.FileInfo.html#27" title="Go to source code"><var>$comment</var></a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="value">
|
|
<div>
|
|
<a href="#$comment" class="anchor">#</a>
|
|
<code><span class="php-quote">''</span></code>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
API documentation generated by <a href="http://apigen.org">ApiGen</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="resources/combined.js?58699d70ee1015ed63e509c64f4dd9d3b29ddbbe"></script>
|
|
<script src="elementlist.js?d1556c44b5531910445709dcbedf0d7a38d1a058"></script>
|
|
</body>
|
|
</html>
|