mirror_php/php-archive
1
0
Fork 0
mirror of https://github.com/splitbrain/php-archive.git synced 2025-07-12 10:26:27 +02:00
Code Issues Releases Wiki Activity
Files
e848b6dd3cdf93f20f382dbad74d1f546d55c9cf
php-archive/source-class-splitbrain.PHPArchive.FileInfo.html
Travis e848b6dd3c Docs updated by Travis
2020-02-06 14:04:34 +00:00

458 lines
42 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="robots" content="noindex">
<title>File FileInfo.php</title>
<link rel="stylesheet" href="resources/bootstrap.min.css?973e37a8502921d56bc02bb55321f45b072b6f71">
<link rel="stylesheet" href="resources/style.css?49f43d3208c5d7e33fa16d36107a345bf11cc00d">
</head>
<body>
<nav id="navigation" class="navbar navbar-default navbar-fixed-top">
<div class="container-fluid">
<div class="navbar-header">
<a href="index.html" class="navbar-brand">Overview</a>
</div>
<div class="collapse navbar-collapse">
<form id="search" class="navbar-form navbar-left" role="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<div class="form-group">
<input type="text" name="q" class="search-query form-control" placeholder="Search">
</div>
</form>
<ul class="nav navbar-nav">
<li>
<span>Namespace</span> </li>
<li>
<span>Class</span> </li>
<li class="divider-vertical"></li>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
<li>
<a href="annotation-group-deprecated.html" title="List of elements with deprecated annotation">
<span>Deprecated</span>
</a>
</li>
<li>
<a href="annotation-group-todo.html" title="List of elements with todo annotation">
<span>Todo</span>
</a>
</li>
</ul>
</div>
</div>
</nav>
<div id="left">
<div id="menu">
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li>
<a href="namespace-splitbrain.html">
splitbrain<span></span>
</a>
<ul>
<li>
<a href="namespace-splitbrain.PHPArchive.html">
PHPArchive </a>
</li>
</ul></li>
</ul>
</div>
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-splitbrain.PHPArchive.Archive.html">splitbrain\PHPArchive\Archive</a></li>
<li><a href="class-splitbrain.PHPArchive.FileInfo.html">splitbrain\PHPArchive\FileInfo</a></li>
<li><a href="class-splitbrain.PHPArchive.Tar.html">splitbrain\PHPArchive\Tar</a></li>
<li><a href="class-splitbrain.PHPArchive.Zip.html">splitbrain\PHPArchive\Zip</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-splitbrain.PHPArchive.ArchiveCorruptedException.html">splitbrain\PHPArchive\ArchiveCorruptedException</a></li>
<li><a href="class-splitbrain.PHPArchive.ArchiveIllegalCompressionException.html">splitbrain\PHPArchive\ArchiveIllegalCompressionException</a></li>
<li><a href="class-splitbrain.PHPArchive.ArchiveIOException.html">splitbrain\PHPArchive\ArchiveIOException</a></li>
<li><a href="class-splitbrain.PHPArchive.FileInfoException.html">splitbrain\PHPArchive\FileInfoException</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<pre id="source"><code><span id="1" class="l"><a href="#1"> 1 </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a href="#2"> 2 </a>
</span><span id="3" class="l"><a href="#3"> 3 </a><span class="php-keyword1">namespace</span> splitbrain\PHPArchive;
</span><span id="4" class="l"><a href="#4"> 4 </a>
</span><span id="5" class="l"><a href="#5"> 5 </a><span class="php-comment">/**
</span></span><span id="6" class="l"><a href="#6"> 6 </a><span class="php-comment"> * Class FileInfo
</span></span><span id="7" class="l"><a href="#7"> 7 </a><span class="php-comment"> *
</span></span><span id="8" class="l"><a href="#8"> 8 </a><span class="php-comment"> * stores meta data about a file in an Archive
</span></span><span id="9" class="l"><a href="#9"> 9 </a><span class="php-comment"> *
</span></span><span id="10" class="l"><a href="#10"> 10 </a><span class="php-comment"> * @author Andreas Gohr &lt;andi@splitbrain.org&gt;
</span></span><span id="11" class="l"><a href="#11"> 11 </a><span class="php-comment"> * @package splitbrain\PHPArchive
</span></span><span id="12" class="l"><a href="#12"> 12 </a><span class="php-comment"> * @license MIT
</span></span><span id="13" class="l"><a href="#13"> 13 </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a href="#14"> 14 </a><span class="php-keyword1">class</span> FileInfo
</span><span id="15" class="l"><a href="#15"> 15 </a>{
</span><span id="16" class="l"><a href="#16"> 16 </a>
</span><span id="17" class="l"><a href="#17"> 17 </a> <span class="php-keyword1">protected</span> <span class="php-var">$isdir</span> = <span class="php-keyword1">false</span>;
</span><span id="18" class="l"><a href="#18"> 18 </a> <span class="php-keyword1">protected</span> <span class="php-var">$path</span> = <span class="php-quote">''</span>;
</span><span id="19" class="l"><a href="#19"> 19 </a> <span class="php-keyword1">protected</span> <span class="php-var">$size</span> = <span class="php-num">0</span>;
</span><span id="20" class="l"><a href="#20"> 20 </a> <span class="php-keyword1">protected</span> <span class="php-var">$csize</span> = <span class="php-num">0</span>;
</span><span id="21" class="l"><a href="#21"> 21 </a> <span class="php-keyword1">protected</span> <span class="php-var">$mtime</span> = <span class="php-num">0</span>;
</span><span id="22" class="l"><a href="#22"> 22 </a> <span class="php-keyword1">protected</span> <span class="php-var">$mode</span> = <span class="php-num">0664</span>;
</span><span id="23" class="l"><a href="#23"> 23 </a> <span class="php-keyword1">protected</span> <span class="php-var">$owner</span> = <span class="php-quote">''</span>;
</span><span id="24" class="l"><a href="#24"> 24 </a> <span class="php-keyword1">protected</span> <span class="php-var">$group</span> = <span class="php-quote">''</span>;
</span><span id="25" class="l"><a href="#25"> 25 </a> <span class="php-keyword1">protected</span> <span class="php-var">$uid</span> = <span class="php-num">0</span>;
</span><span id="26" class="l"><a href="#26"> 26 </a> <span class="php-keyword1">protected</span> <span class="php-var">$gid</span> = <span class="php-num">0</span>;
</span><span id="27" class="l"><a href="#27"> 27 </a> <span class="php-keyword1">protected</span> <span class="php-var">$comment</span> = <span class="php-quote">''</span>;
</span><span id="28" class="l"><a href="#28"> 28 </a>
</span><span id="29" class="l"><a href="#29"> 29 </a> <span class="php-comment">/**
</span></span><span id="30" class="l"><a href="#30"> 30 </a><span class="php-comment"> * initialize dynamic defaults
</span></span><span id="31" class="l"><a href="#31"> 31 </a><span class="php-comment"> *
</span></span><span id="32" class="l"><a href="#32"> 32 </a><span class="php-comment"> * @param string $path The path of the file, can also be set later through setPath()
</span></span><span id="33" class="l"><a href="#33"> 33 </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a href="#34"> 34 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> __construct(<span class="php-var">$path</span> = <span class="php-quote">''</span>)
</span><span id="35" class="l"><a href="#35"> 35 </a> {
</span><span id="36" class="l"><a href="#36"> 36 </a> <span class="php-var">$this</span>-&gt;mtime = <span class="php-keyword2">time</span>();
</span><span id="37" class="l"><a href="#37"> 37 </a> <span class="php-var">$this</span>-&gt;setPath(<span class="php-var">$path</span>);
</span><span id="38" class="l"><a href="#38"> 38 </a> }
</span><span id="39" class="l"><a href="#39"> 39 </a>
</span><span id="40" class="l"><a href="#40"> 40 </a> <span class="php-comment">/**
</span></span><span id="41" class="l"><a href="#41"> 41 </a><span class="php-comment"> * Factory to build FileInfo from existing file or directory
</span></span><span id="42" class="l"><a href="#42"> 42 </a><span class="php-comment"> *
</span></span><span id="43" class="l"><a href="#43"> 43 </a><span class="php-comment"> * @param string $path path to a file on the local file system
</span></span><span id="44" class="l"><a href="#44"> 44 </a><span class="php-comment"> * @param string $as optional path to use inside the archive
</span></span><span id="45" class="l"><a href="#45"> 45 </a><span class="php-comment"> * @throws FileInfoException
</span></span><span id="46" class="l"><a href="#46"> 46 </a><span class="php-comment"> * @return FileInfo
</span></span><span id="47" class="l"><a href="#47"> 47 </a><span class="php-comment"> */</span>
</span><span id="48" class="l"><a href="#48"> 48 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> fromPath(<span class="php-var">$path</span>, <span class="php-var">$as</span> = <span class="php-quote">''</span>)
</span><span id="49" class="l"><a href="#49"> 49 </a> {
</span><span id="50" class="l"><a href="#50"> 50 </a> <span class="php-keyword2">clearstatcache</span>(<span class="php-keyword1">false</span>, <span class="php-var">$path</span>);
</span><span id="51" class="l"><a href="#51"> 51 </a>
</span><span id="52" class="l"><a href="#52"> 52 </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">file_exists</span>(<span class="php-var">$path</span>)) {
</span><span id="53" class="l"><a href="#53"> 53 </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> FileInfoException(<span class="php-quote">&quot;</span><span class="php-var">$path</span><span class="php-quote"> does not exist&quot;</span>);
</span><span id="54" class="l"><a href="#54"> 54 </a> }
</span><span id="55" class="l"><a href="#55"> 55 </a>
</span><span id="56" class="l"><a href="#56"> 56 </a> <span class="php-var">$stat</span> = <span class="php-keyword2">stat</span>(<span class="php-var">$path</span>);
</span><span id="57" class="l"><a href="#57"> 57 </a> <span class="php-var">$file</span> = <span class="php-keyword1">new</span> FileInfo();
</span><span id="58" class="l"><a href="#58"> 58 </a>
</span><span id="59" class="l"><a href="#59"> 59 </a> <span class="php-var">$file</span>-&gt;setPath(<span class="php-var">$path</span>);
</span><span id="60" class="l"><a href="#60"> 60 </a> <span class="php-var">$file</span>-&gt;setIsdir(<span class="php-keyword2">is_dir</span>(<span class="php-var">$path</span>));
</span><span id="61" class="l"><a href="#61"> 61 </a> <span class="php-var">$file</span>-&gt;setMode(<span class="php-keyword2">fileperms</span>(<span class="php-var">$path</span>));
</span><span id="62" class="l"><a href="#62"> 62 </a> <span class="php-var">$file</span>-&gt;setOwner(<span class="php-keyword2">fileowner</span>(<span class="php-var">$path</span>));
</span><span id="63" class="l"><a href="#63"> 63 </a> <span class="php-var">$file</span>-&gt;setGroup(<span class="php-keyword2">filegroup</span>(<span class="php-var">$path</span>));
</span><span id="64" class="l"><a href="#64"> 64 </a> <span class="php-var">$file</span>-&gt;setSize(<span class="php-keyword2">filesize</span>(<span class="php-var">$path</span>));
</span><span id="65" class="l"><a href="#65"> 65 </a> <span class="php-var">$file</span>-&gt;setUid(<span class="php-var">$stat</span>[<span class="php-quote">'uid'</span>]);
</span><span id="66" class="l"><a href="#66"> 66 </a> <span class="php-var">$file</span>-&gt;setGid(<span class="php-var">$stat</span>[<span class="php-quote">'gid'</span>]);
</span><span id="67" class="l"><a href="#67"> 67 </a> <span class="php-var">$file</span>-&gt;setMtime(<span class="php-var">$stat</span>[<span class="php-quote">'mtime'</span>]);
</span><span id="68" class="l"><a href="#68"> 68 </a>
</span><span id="69" class="l"><a href="#69"> 69 </a> <span class="php-keyword1">if</span> (<span class="php-var">$as</span>) {
</span><span id="70" class="l"><a href="#70"> 70 </a> <span class="php-var">$file</span>-&gt;setPath(<span class="php-var">$as</span>);
</span><span id="71" class="l"><a href="#71"> 71 </a> }
</span><span id="72" class="l"><a href="#72"> 72 </a>
</span><span id="73" class="l"><a href="#73"> 73 </a> <span class="php-keyword1">return</span> <span class="php-var">$file</span>;
</span><span id="74" class="l"><a href="#74"> 74 </a> }
</span><span id="75" class="l"><a href="#75"> 75 </a>
</span><span id="76" class="l"><a href="#76"> 76 </a> <span class="php-comment">/**
</span></span><span id="77" class="l"><a href="#77"> 77 </a><span class="php-comment"> * @return int the filesize. always 0 for directories
</span></span><span id="78" class="l"><a href="#78"> 78 </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a href="#79"> 79 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getSize()
</span><span id="80" class="l"><a href="#80"> 80 </a> {
</span><span id="81" class="l"><a href="#81"> 81 </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>-&gt;isdir) <span class="php-keyword1">return</span> <span class="php-num">0</span>;
</span><span id="82" class="l"><a href="#82"> 82 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;size;
</span><span id="83" class="l"><a href="#83"> 83 </a> }
</span><span id="84" class="l"><a href="#84"> 84 </a>
</span><span id="85" class="l"><a href="#85"> 85 </a> <span class="php-comment">/**
</span></span><span id="86" class="l"><a href="#86"> 86 </a><span class="php-comment"> * @param int $size
</span></span><span id="87" class="l"><a href="#87"> 87 </a><span class="php-comment"> */</span>
</span><span id="88" class="l"><a href="#88"> 88 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setSize(<span class="php-var">$size</span>)
</span><span id="89" class="l"><a href="#89"> 89 </a> {
</span><span id="90" class="l"><a href="#90"> 90 </a> <span class="php-var">$this</span>-&gt;size = <span class="php-var">$size</span>;
</span><span id="91" class="l"><a href="#91"> 91 </a> }
</span><span id="92" class="l"><a href="#92"> 92 </a>
</span><span id="93" class="l"><a href="#93"> 93 </a> <span class="php-comment">/**
</span></span><span id="94" class="l"><a href="#94"> 94 </a><span class="php-comment"> * @return int
</span></span><span id="95" class="l"><a href="#95"> 95 </a><span class="php-comment"> */</span>
</span><span id="96" class="l"><a href="#96"> 96 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getCompressedSize()
</span><span id="97" class="l"><a href="#97"> 97 </a> {
</span><span id="98" class="l"><a href="#98"> 98 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;csize;
</span><span id="99" class="l"><a href="#99"> 99 </a> }
</span><span id="100" class="l"><a href="#100">100 </a>
</span><span id="101" class="l"><a href="#101">101 </a> <span class="php-comment">/**
</span></span><span id="102" class="l"><a href="#102">102 </a><span class="php-comment"> * @param int $csize
</span></span><span id="103" class="l"><a href="#103">103 </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a href="#104">104 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setCompressedSize(<span class="php-var">$csize</span>)
</span><span id="105" class="l"><a href="#105">105 </a> {
</span><span id="106" class="l"><a href="#106">106 </a> <span class="php-var">$this</span>-&gt;csize = <span class="php-var">$csize</span>;
</span><span id="107" class="l"><a href="#107">107 </a> }
</span><span id="108" class="l"><a href="#108">108 </a>
</span><span id="109" class="l"><a href="#109">109 </a> <span class="php-comment">/**
</span></span><span id="110" class="l"><a href="#110">110 </a><span class="php-comment"> * @return int
</span></span><span id="111" class="l"><a href="#111">111 </a><span class="php-comment"> */</span>
</span><span id="112" class="l"><a href="#112">112 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getMtime()
</span><span id="113" class="l"><a href="#113">113 </a> {
</span><span id="114" class="l"><a href="#114">114 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;mtime;
</span><span id="115" class="l"><a href="#115">115 </a> }
</span><span id="116" class="l"><a href="#116">116 </a>
</span><span id="117" class="l"><a href="#117">117 </a> <span class="php-comment">/**
</span></span><span id="118" class="l"><a href="#118">118 </a><span class="php-comment"> * @param int $mtime
</span></span><span id="119" class="l"><a href="#119">119 </a><span class="php-comment"> */</span>
</span><span id="120" class="l"><a href="#120">120 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setMtime(<span class="php-var">$mtime</span>)
</span><span id="121" class="l"><a href="#121">121 </a> {
</span><span id="122" class="l"><a href="#122">122 </a> <span class="php-var">$this</span>-&gt;mtime = <span class="php-var">$mtime</span>;
</span><span id="123" class="l"><a href="#123">123 </a> }
</span><span id="124" class="l"><a href="#124">124 </a>
</span><span id="125" class="l"><a href="#125">125 </a> <span class="php-comment">/**
</span></span><span id="126" class="l"><a href="#126">126 </a><span class="php-comment"> * @return int
</span></span><span id="127" class="l"><a href="#127">127 </a><span class="php-comment"> */</span>
</span><span id="128" class="l"><a href="#128">128 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getGid()
</span><span id="129" class="l"><a href="#129">129 </a> {
</span><span id="130" class="l"><a href="#130">130 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;gid;
</span><span id="131" class="l"><a href="#131">131 </a> }
</span><span id="132" class="l"><a href="#132">132 </a>
</span><span id="133" class="l"><a href="#133">133 </a> <span class="php-comment">/**
</span></span><span id="134" class="l"><a href="#134">134 </a><span class="php-comment"> * @param int $gid
</span></span><span id="135" class="l"><a href="#135">135 </a><span class="php-comment"> */</span>
</span><span id="136" class="l"><a href="#136">136 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setGid(<span class="php-var">$gid</span>)
</span><span id="137" class="l"><a href="#137">137 </a> {
</span><span id="138" class="l"><a href="#138">138 </a> <span class="php-var">$this</span>-&gt;gid = <span class="php-var">$gid</span>;
</span><span id="139" class="l"><a href="#139">139 </a> }
</span><span id="140" class="l"><a href="#140">140 </a>
</span><span id="141" class="l"><a href="#141">141 </a> <span class="php-comment">/**
</span></span><span id="142" class="l"><a href="#142">142 </a><span class="php-comment"> * @return int
</span></span><span id="143" class="l"><a href="#143">143 </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a href="#144">144 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getUid()
</span><span id="145" class="l"><a href="#145">145 </a> {
</span><span id="146" class="l"><a href="#146">146 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;uid;
</span><span id="147" class="l"><a href="#147">147 </a> }
</span><span id="148" class="l"><a href="#148">148 </a>
</span><span id="149" class="l"><a href="#149">149 </a> <span class="php-comment">/**
</span></span><span id="150" class="l"><a href="#150">150 </a><span class="php-comment"> * @param int $uid
</span></span><span id="151" class="l"><a href="#151">151 </a><span class="php-comment"> */</span>
</span><span id="152" class="l"><a href="#152">152 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setUid(<span class="php-var">$uid</span>)
</span><span id="153" class="l"><a href="#153">153 </a> {
</span><span id="154" class="l"><a href="#154">154 </a> <span class="php-var">$this</span>-&gt;uid = <span class="php-var">$uid</span>;
</span><span id="155" class="l"><a href="#155">155 </a> }
</span><span id="156" class="l"><a href="#156">156 </a>
</span><span id="157" class="l"><a href="#157">157 </a> <span class="php-comment">/**
</span></span><span id="158" class="l"><a href="#158">158 </a><span class="php-comment"> * @return string
</span></span><span id="159" class="l"><a href="#159">159 </a><span class="php-comment"> */</span>
</span><span id="160" class="l"><a href="#160">160 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getComment()
</span><span id="161" class="l"><a href="#161">161 </a> {
</span><span id="162" class="l"><a href="#162">162 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;comment;
</span><span id="163" class="l"><a href="#163">163 </a> }
</span><span id="164" class="l"><a href="#164">164 </a>
</span><span id="165" class="l"><a href="#165">165 </a> <span class="php-comment">/**
</span></span><span id="166" class="l"><a href="#166">166 </a><span class="php-comment"> * @param string $comment
</span></span><span id="167" class="l"><a href="#167">167 </a><span class="php-comment"> */</span>
</span><span id="168" class="l"><a href="#168">168 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setComment(<span class="php-var">$comment</span>)
</span><span id="169" class="l"><a href="#169">169 </a> {
</span><span id="170" class="l"><a href="#170">170 </a> <span class="php-var">$this</span>-&gt;comment = <span class="php-var">$comment</span>;
</span><span id="171" class="l"><a href="#171">171 </a> }
</span><span id="172" class="l"><a href="#172">172 </a>
</span><span id="173" class="l"><a href="#173">173 </a> <span class="php-comment">/**
</span></span><span id="174" class="l"><a href="#174">174 </a><span class="php-comment"> * @return string
</span></span><span id="175" class="l"><a href="#175">175 </a><span class="php-comment"> */</span>
</span><span id="176" class="l"><a href="#176">176 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getGroup()
</span><span id="177" class="l"><a href="#177">177 </a> {
</span><span id="178" class="l"><a href="#178">178 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;group;
</span><span id="179" class="l"><a href="#179">179 </a> }
</span><span id="180" class="l"><a href="#180">180 </a>
</span><span id="181" class="l"><a href="#181">181 </a> <span class="php-comment">/**
</span></span><span id="182" class="l"><a href="#182">182 </a><span class="php-comment"> * @param string $group
</span></span><span id="183" class="l"><a href="#183">183 </a><span class="php-comment"> */</span>
</span><span id="184" class="l"><a href="#184">184 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setGroup(<span class="php-var">$group</span>)
</span><span id="185" class="l"><a href="#185">185 </a> {
</span><span id="186" class="l"><a href="#186">186 </a> <span class="php-var">$this</span>-&gt;group = <span class="php-var">$group</span>;
</span><span id="187" class="l"><a href="#187">187 </a> }
</span><span id="188" class="l"><a href="#188">188 </a>
</span><span id="189" class="l"><a href="#189">189 </a> <span class="php-comment">/**
</span></span><span id="190" class="l"><a href="#190">190 </a><span class="php-comment"> * @return boolean
</span></span><span id="191" class="l"><a href="#191">191 </a><span class="php-comment"> */</span>
</span><span id="192" class="l"><a href="#192">192 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getIsdir()
</span><span id="193" class="l"><a href="#193">193 </a> {
</span><span id="194" class="l"><a href="#194">194 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;isdir;
</span><span id="195" class="l"><a href="#195">195 </a> }
</span><span id="196" class="l"><a href="#196">196 </a>
</span><span id="197" class="l"><a href="#197">197 </a> <span class="php-comment">/**
</span></span><span id="198" class="l"><a href="#198">198 </a><span class="php-comment"> * @param boolean $isdir
</span></span><span id="199" class="l"><a href="#199">199 </a><span class="php-comment"> */</span>
</span><span id="200" class="l"><a href="#200">200 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setIsdir(<span class="php-var">$isdir</span>)
</span><span id="201" class="l"><a href="#201">201 </a> {
</span><span id="202" class="l"><a href="#202">202 </a> <span class="php-comment">// default mode for directories</span>
</span><span id="203" class="l"><a href="#203">203 </a> <span class="php-keyword1">if</span> (<span class="php-var">$isdir</span> &amp;&amp; <span class="php-var">$this</span>-&gt;mode === <span class="php-num">0664</span>) {
</span><span id="204" class="l"><a href="#204">204 </a> <span class="php-var">$this</span>-&gt;mode = <span class="php-num">0775</span>;
</span><span id="205" class="l"><a href="#205">205 </a> }
</span><span id="206" class="l"><a href="#206">206 </a> <span class="php-var">$this</span>-&gt;isdir = <span class="php-var">$isdir</span>;
</span><span id="207" class="l"><a href="#207">207 </a> }
</span><span id="208" class="l"><a href="#208">208 </a>
</span><span id="209" class="l"><a href="#209">209 </a> <span class="php-comment">/**
</span></span><span id="210" class="l"><a href="#210">210 </a><span class="php-comment"> * @return int
</span></span><span id="211" class="l"><a href="#211">211 </a><span class="php-comment"> */</span>
</span><span id="212" class="l"><a href="#212">212 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getMode()
</span><span id="213" class="l"><a href="#213">213 </a> {
</span><span id="214" class="l"><a href="#214">214 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;mode;
</span><span id="215" class="l"><a href="#215">215 </a> }
</span><span id="216" class="l"><a href="#216">216 </a>
</span><span id="217" class="l"><a href="#217">217 </a> <span class="php-comment">/**
</span></span><span id="218" class="l"><a href="#218">218 </a><span class="php-comment"> * @param int $mode
</span></span><span id="219" class="l"><a href="#219">219 </a><span class="php-comment"> */</span>
</span><span id="220" class="l"><a href="#220">220 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setMode(<span class="php-var">$mode</span>)
</span><span id="221" class="l"><a href="#221">221 </a> {
</span><span id="222" class="l"><a href="#222">222 </a> <span class="php-var">$this</span>-&gt;mode = <span class="php-var">$mode</span>;
</span><span id="223" class="l"><a href="#223">223 </a> }
</span><span id="224" class="l"><a href="#224">224 </a>
</span><span id="225" class="l"><a href="#225">225 </a> <span class="php-comment">/**
</span></span><span id="226" class="l"><a href="#226">226 </a><span class="php-comment"> * @return string
</span></span><span id="227" class="l"><a href="#227">227 </a><span class="php-comment"> */</span>
</span><span id="228" class="l"><a href="#228">228 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getOwner()
</span><span id="229" class="l"><a href="#229">229 </a> {
</span><span id="230" class="l"><a href="#230">230 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;owner;
</span><span id="231" class="l"><a href="#231">231 </a> }
</span><span id="232" class="l"><a href="#232">232 </a>
</span><span id="233" class="l"><a href="#233">233 </a> <span class="php-comment">/**
</span></span><span id="234" class="l"><a href="#234">234 </a><span class="php-comment"> * @param string $owner
</span></span><span id="235" class="l"><a href="#235">235 </a><span class="php-comment"> */</span>
</span><span id="236" class="l"><a href="#236">236 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setOwner(<span class="php-var">$owner</span>)
</span><span id="237" class="l"><a href="#237">237 </a> {
</span><span id="238" class="l"><a href="#238">238 </a> <span class="php-var">$this</span>-&gt;owner = <span class="php-var">$owner</span>;
</span><span id="239" class="l"><a href="#239">239 </a> }
</span><span id="240" class="l"><a href="#240">240 </a>
</span><span id="241" class="l"><a href="#241">241 </a> <span class="php-comment">/**
</span></span><span id="242" class="l"><a href="#242">242 </a><span class="php-comment"> * @return string
</span></span><span id="243" class="l"><a href="#243">243 </a><span class="php-comment"> */</span>
</span><span id="244" class="l"><a href="#244">244 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getPath()
</span><span id="245" class="l"><a href="#245">245 </a> {
</span><span id="246" class="l"><a href="#246">246 </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;path;
</span><span id="247" class="l"><a href="#247">247 </a> }
</span><span id="248" class="l"><a href="#248">248 </a>
</span><span id="249" class="l"><a href="#249">249 </a> <span class="php-comment">/**
</span></span><span id="250" class="l"><a href="#250">250 </a><span class="php-comment"> * @param string $path
</span></span><span id="251" class="l"><a href="#251">251 </a><span class="php-comment"> */</span>
</span><span id="252" class="l"><a href="#252">252 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setPath(<span class="php-var">$path</span>)
</span><span id="253" class="l"><a href="#253">253 </a> {
</span><span id="254" class="l"><a href="#254">254 </a> <span class="php-var">$this</span>-&gt;path = <span class="php-var">$this</span>-&gt;cleanPath(<span class="php-var">$path</span>);
</span><span id="255" class="l"><a href="#255">255 </a> }
</span><span id="256" class="l"><a href="#256">256 </a>
</span><span id="257" class="l"><a href="#257">257 </a> <span class="php-comment">/**
</span></span><span id="258" class="l"><a href="#258">258 </a><span class="php-comment"> * Cleans up a path and removes relative parts, also strips leading slashes
</span></span><span id="259" class="l"><a href="#259">259 </a><span class="php-comment"> *
</span></span><span id="260" class="l"><a href="#260">260 </a><span class="php-comment"> * @param string $path
</span></span><span id="261" class="l"><a href="#261">261 </a><span class="php-comment"> * @return string
</span></span><span id="262" class="l"><a href="#262">262 </a><span class="php-comment"> */</span>
</span><span id="263" class="l"><a href="#263">263 </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> cleanPath(<span class="php-var">$path</span>)
</span><span id="264" class="l"><a href="#264">264 </a> {
</span><span id="265" class="l"><a href="#265">265 </a> <span class="php-var">$path</span> = <span class="php-keyword2">str_replace</span>(<span class="php-quote">'\\'</span>, <span class="php-quote">'/'</span>, <span class="php-var">$path</span>);
</span><span id="266" class="l"><a href="#266">266 </a> <span class="php-var">$path</span> = <span class="php-keyword2">explode</span>(<span class="php-quote">'/'</span>, <span class="php-var">$path</span>);
</span><span id="267" class="l"><a href="#267">267 </a> <span class="php-var">$newpath</span> = <span class="php-keyword1">array</span>();
</span><span id="268" class="l"><a href="#268">268 </a> <span class="php-keyword1">foreach</span> (<span class="php-var">$path</span> <span class="php-keyword1">as</span> <span class="php-var">$p</span>) {
</span><span id="269" class="l"><a href="#269">269 </a> <span class="php-keyword1">if</span> (<span class="php-var">$p</span> === <span class="php-quote">''</span> || <span class="php-var">$p</span> === <span class="php-quote">'.'</span>) {
</span><span id="270" class="l"><a href="#270">270 </a> <span class="php-keyword1">continue</span>;
</span><span id="271" class="l"><a href="#271">271 </a> }
</span><span id="272" class="l"><a href="#272">272 </a> <span class="php-keyword1">if</span> (<span class="php-var">$p</span> === <span class="php-quote">'..'</span>) {
</span><span id="273" class="l"><a href="#273">273 </a> <span class="php-keyword2">array_pop</span>(<span class="php-var">$newpath</span>);
</span><span id="274" class="l"><a href="#274">274 </a> <span class="php-keyword1">continue</span>;
</span><span id="275" class="l"><a href="#275">275 </a> }
</span><span id="276" class="l"><a href="#276">276 </a> <span class="php-keyword2">array_push</span>(<span class="php-var">$newpath</span>, <span class="php-var">$p</span>);
</span><span id="277" class="l"><a href="#277">277 </a> }
</span><span id="278" class="l"><a href="#278">278 </a> <span class="php-keyword1">return</span> <span class="php-keyword2">trim</span>(<span class="php-keyword2">implode</span>(<span class="php-quote">'/'</span>, <span class="php-var">$newpath</span>), <span class="php-quote">'/'</span>);
</span><span id="279" class="l"><a href="#279">279 </a> }
</span><span id="280" class="l"><a href="#280">280 </a>
</span><span id="281" class="l"><a href="#281">281 </a> <span class="php-comment">/**
</span></span><span id="282" class="l"><a href="#282">282 </a><span class="php-comment"> * Strip given prefix or number of path segments from the filename
</span></span><span id="283" class="l"><a href="#283">283 </a><span class="php-comment"> *
</span></span><span id="284" class="l"><a href="#284">284 </a><span class="php-comment"> * The $strip parameter allows you to strip a certain number of path components from the filenames
</span></span><span id="285" class="l"><a href="#285">285 </a><span class="php-comment"> * found in the tar file, similar to the --strip-components feature of GNU tar. This is triggered when
</span></span><span id="286" class="l"><a href="#286">286 </a><span class="php-comment"> * an integer is passed as $strip.
</span></span><span id="287" class="l"><a href="#287">287 </a><span class="php-comment"> * Alternatively a fixed string prefix may be passed in $strip. If the filename matches this prefix,
</span></span><span id="288" class="l"><a href="#288">288 </a><span class="php-comment"> * the prefix will be stripped. It is recommended to give prefixes with a trailing slash.
</span></span><span id="289" class="l"><a href="#289">289 </a><span class="php-comment"> *
</span></span><span id="290" class="l"><a href="#290">290 </a><span class="php-comment"> * @param int|string $strip
</span></span><span id="291" class="l"><a href="#291">291 </a><span class="php-comment"> */</span>
</span><span id="292" class="l"><a href="#292">292 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> strip(<span class="php-var">$strip</span>)
</span><span id="293" class="l"><a href="#293">293 </a> {
</span><span id="294" class="l"><a href="#294">294 </a> <span class="php-var">$filename</span> = <span class="php-var">$this</span>-&gt;getPath();
</span><span id="295" class="l"><a href="#295">295 </a> <span class="php-var">$striplen</span> = <span class="php-keyword2">strlen</span>(<span class="php-var">$strip</span>);
</span><span id="296" class="l"><a href="#296">296 </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">is_int</span>(<span class="php-var">$strip</span>)) {
</span><span id="297" class="l"><a href="#297">297 </a> <span class="php-comment">// if $strip is an integer we strip this many path components</span>
</span><span id="298" class="l"><a href="#298">298 </a> <span class="php-var">$parts</span> = <span class="php-keyword2">explode</span>(<span class="php-quote">'/'</span>, <span class="php-var">$filename</span>);
</span><span id="299" class="l"><a href="#299">299 </a> <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>-&gt;getIsdir()) {
</span><span id="300" class="l"><a href="#300">300 </a> <span class="php-var">$base</span> = <span class="php-keyword2">array_pop</span>(<span class="php-var">$parts</span>); <span class="php-comment">// keep filename itself</span>
</span><span id="301" class="l"><a href="#301">301 </a> } <span class="php-keyword1">else</span> {
</span><span id="302" class="l"><a href="#302">302 </a> <span class="php-var">$base</span> = <span class="php-quote">''</span>;
</span><span id="303" class="l"><a href="#303">303 </a> }
</span><span id="304" class="l"><a href="#304">304 </a> <span class="php-var">$filename</span> = <span class="php-keyword2">join</span>(<span class="php-quote">'/'</span>, <span class="php-keyword2">array_slice</span>(<span class="php-var">$parts</span>, <span class="php-var">$strip</span>));
</span><span id="305" class="l"><a href="#305">305 </a> <span class="php-keyword1">if</span> (<span class="php-var">$base</span>) {
</span><span id="306" class="l"><a href="#306">306 </a> <span class="php-var">$filename</span> .= <span class="php-quote">&quot;/</span><span class="php-var">$base</span><span class="php-quote">&quot;</span>;
</span><span id="307" class="l"><a href="#307">307 </a> }
</span><span id="308" class="l"><a href="#308">308 </a> } <span class="php-keyword1">else</span> {
</span><span id="309" class="l"><a href="#309">309 </a> <span class="php-comment">// if strip is a string, we strip a prefix here</span>
</span><span id="310" class="l"><a href="#310">310 </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">substr</span>(<span class="php-var">$filename</span>, <span class="php-num">0</span>, <span class="php-var">$striplen</span>) == <span class="php-var">$strip</span>) {
</span><span id="311" class="l"><a href="#311">311 </a> <span class="php-var">$filename</span> = <span class="php-keyword2">substr</span>(<span class="php-var">$filename</span>, <span class="php-var">$striplen</span>);
</span><span id="312" class="l"><a href="#312">312 </a> }
</span><span id="313" class="l"><a href="#313">313 </a> }
</span><span id="314" class="l"><a href="#314">314 </a>
</span><span id="315" class="l"><a href="#315">315 </a> <span class="php-var">$this</span>-&gt;setPath(<span class="php-var">$filename</span>);
</span><span id="316" class="l"><a href="#316">316 </a> }
</span><span id="317" class="l"><a href="#317">317 </a>
</span><span id="318" class="l"><a href="#318">318 </a> <span class="php-comment">/**
</span></span><span id="319" class="l"><a href="#319">319 </a><span class="php-comment"> * Does the file match the given include and exclude expressions?
</span></span><span id="320" class="l"><a href="#320">320 </a><span class="php-comment"> *
</span></span><span id="321" class="l"><a href="#321">321 </a><span class="php-comment"> * Exclude rules take precedence over include rules
</span></span><span id="322" class="l"><a href="#322">322 </a><span class="php-comment"> *
</span></span><span id="323" class="l"><a href="#323">323 </a><span class="php-comment"> * @param string $include Regular expression of files to include
</span></span><span id="324" class="l"><a href="#324">324 </a><span class="php-comment"> * @param string $exclude Regular expression of files to exclude
</span></span><span id="325" class="l"><a href="#325">325 </a><span class="php-comment"> * @return bool
</span></span><span id="326" class="l"><a href="#326">326 </a><span class="php-comment"> */</span>
</span><span id="327" class="l"><a href="#327">327 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> match(<span class="php-var">$include</span> = <span class="php-quote">''</span>, <span class="php-var">$exclude</span> = <span class="php-quote">''</span>)
</span><span id="328" class="l"><a href="#328">328 </a> {
</span><span id="329" class="l"><a href="#329">329 </a> <span class="php-var">$extract</span> = <span class="php-keyword1">true</span>;
</span><span id="330" class="l"><a href="#330">330 </a> <span class="php-keyword1">if</span> (<span class="php-var">$include</span> &amp;&amp; !<span class="php-keyword2">preg_match</span>(<span class="php-var">$include</span>, <span class="php-var">$this</span>-&gt;getPath())) {
</span><span id="331" class="l"><a href="#331">331 </a> <span class="php-var">$extract</span> = <span class="php-keyword1">false</span>;
</span><span id="332" class="l"><a href="#332">332 </a> }
</span><span id="333" class="l"><a href="#333">333 </a> <span class="php-keyword1">if</span> (<span class="php-var">$exclude</span> &amp;&amp; <span class="php-keyword2">preg_match</span>(<span class="php-var">$exclude</span>, <span class="php-var">$this</span>-&gt;getPath())) {
</span><span id="334" class="l"><a href="#334">334 </a> <span class="php-var">$extract</span> = <span class="php-keyword1">false</span>;
</span><span id="335" class="l"><a href="#335">335 </a> }
</span><span id="336" class="l"><a href="#336">336 </a>
</span><span id="337" class="l"><a href="#337">337 </a> <span class="php-keyword1">return</span> <span class="php-var">$extract</span>;
</span><span id="338" class="l"><a href="#338">338 </a> }
</span><span id="339" class="l"><a href="#339">339 </a>}
</span><span id="340" class="l"><a href="#340">340 </a>
</span><span id="341" class="l"><a href="#341">341 </a></span></code></pre>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
<script src="resources/combined.js?be84a76b6587140e2797865002e3f9737f6a5dab"></script>
<script src="elementlist.js?d1556c44b5531910445709dcbedf0d7a38d1a058"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink