mirror_php/php-archive
1
0
Fork 0
mirror of https://github.com/splitbrain/php-archive.git synced 2025-07-10 09:26:32 +02:00
Code Issues Releases Wiki Activity
Files
gh-pages
php-archive/source-class-splitbrain.PHPArchive.Archive.html
ApiGen Github Bot ad2e77b4e3 📖 #2 - ApiGen Code Docs Regenerated / ⚡ Triggered By d53bf2ed77
2021-02-05 12:40:13 +00:00

237 lines
23 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="robots" content="noindex">
<title>File Archive.php</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>
<a href="namespace-splitbrain.html">
splitbrain<span></span>
</a>
<ul>
<li>
<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">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">
<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>
<span>Namespace</span> </li>
<li>
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<pre class="numbers"><code><span class="l"><a href="#1"> 1: </a></span><span class="l"><a href="#2"> 2: </a></span><span class="l"><a href="#3"> 3: </a></span><span class="l"><a href="#4"> 4: </a></span><span class="l"><a href="#5"> 5: </a></span><span class="l"><a href="#6"> 6: </a></span><span class="l"><a href="#7"> 7: </a></span><span class="l"><a href="#8"> 8: </a></span><span class="l"><a href="#9"> 9: </a></span><span class="l"><a href="#10"> 10: </a></span><span class="l"><a href="#11"> 11: </a></span><span class="l"><a href="#12"> 12: </a></span><span class="l"><a href="#13"> 13: </a></span><span class="l"><a href="#14"> 14: </a></span><span class="l"><a href="#15"> 15: </a></span><span class="l"><a href="#16"> 16: </a></span></span><span class="l"><a href="#17"> 17: </a></span></span><span class="l"><a href="#18"> 18: </a></span></span><span class="l"><a href="#19"> 19: </a></span></span><span class="l"><a href="#20"> 20: </a></span></span><span class="l"><a href="#21"> 21: </a></span></span><span class="l"><a href="#22"> 22: </a></span><span class="l"><a href="#23"> 23: </a></span><span class="l"><a href="#24"> 24: </a></span><span class="l"><a href="#25"> 25: </a></span></span><span class="l"><a href="#26"> 26: </a></span></span><span class="l"><a href="#27"> 27: </a></span></span><span class="l"><a href="#28"> 28: </a></span></span><span class="l"><a href="#29"> 29: </a></span></span><span class="l"><a href="#30"> 30: </a></span><span class="l"><a href="#31"> 31: </a></span><span class="l"><a href="#32"> 32: </a></span><span class="l"><a href="#33"> 33: </a></span></span><span class="l"><a href="#34"> 34: </a></span></span><span class="l"><a href="#35"> 35: </a></span></span><span class="l"><a href="#36"> 36: </a></span></span><span class="l"><a href="#37"> 37: </a></span></span><span class="l"><a href="#38"> 38: </a></span></span><span class="l"><a href="#39"> 39: </a></span></span><span class="l"><a href="#40"> 40: </a></span></span><span class="l"><a href="#41"> 41: </a></span></span><span class="l"><a href="#42"> 42: </a></span><span class="l"><a href="#43"> 43: </a></span><span class="l"><a href="#44"> 44: </a></span><span class="l"><a href="#45"> 45: </a></span></span><span class="l"><a href="#46"> 46: </a></span></span><span class="l"><a href="#47"> 47: </a></span></span><span class="l"><a href="#48"> 48: </a></span></span><span class="l"><a href="#49"> 49: </a></span></span><span class="l"><a href="#50"> 50: </a></span></span><span class="l"><a href="#51"> 51: </a></span></span><span class="l"><a href="#52"> 52: </a></span></span><span class="l"><a href="#53"> 53: </a></span></span><span class="l"><a href="#54"> 54: </a></span></span><span class="l"><a href="#55"> 55: </a></span></span><span class="l"><a href="#56"> 56: </a></span></span><span class="l"><a href="#57"> 57: </a></span></span><span class="l"><a href="#58"> 58: </a></span></span><span class="l"><a href="#59"> 59: </a></span></span><span class="l"><a href="#60"> 60: </a></span></span><span class="l"><a href="#61"> 61: </a></span></span><span class="l"><a href="#62"> 62: </a></span></span><span class="l"><a href="#63"> 63: </a></span></span><span class="l"><a href="#64"> 64: </a></span></span><span class="l"><a href="#65"> 65: </a></span></span><span class="l"><a href="#66"> 66: </a></span></span><span class="l"><a href="#67"> 67: </a></span></span><span class="l"><a href="#68"> 68: </a></span><span class="l"><a href="#69"> 69: </a></span><span class="l"><a href="#70"> 70: </a></span><span class="l"><a href="#71"> 71: </a></span></span><span class="l"><a href="#72"> 72: </a></span></span><span class="l"><a href="#73"> 73: </a></span></span><span class="l"><a href="#74"> 74: </a></span></span><span class="l"><a href="#75"> 75: </a></span></span><span class="l"><a href="#76"> 76: </a></span></span><span class="l"><a href="#77"> 77: </a></span><span class="l"><a href="#78"> 78: </a></span><span class="l"><a href="#79"> 79: </a></span><span class="l"><a href="#80"> 80: </a></span></span><span class="l"><a href="#81"> 81: </a></span></span><span class="l"><a href="#82"> 82: </a></span></span><span class="l"><a href="#83"> 83: </a></span></span><span class="l"><a href="#84"> 84: </a></span></span><span class="l"><a href="#85"> 85: </a></span></span><span class="l"><a href="#86"> 86: </a></span><span class="l"><a href="#87"> 87: </a></span><span class="l"><a href="#88"> 88: </a></span><span class="l"><a href="#89"> 89: </a></span></span><span class="l"><a href="#90"> 90: </a></span></span><span class="l"><a href="#91"> 91: </a></span></span><span class="l"><a href="#92"> 92: </a></span></span><span class="l"><a href="#93"> 93: </a></span></span><span class="l"><a href="#94"> 94: </a></span></span><span class="l"><a href="#95"> 95: </a></span><span class="l"><a href="#96"> 96: </a></span><span class="l"><a href="#97"> 97: </a></span><span class="l"><a href="#98"> 98: </a></span></span><span class="l"><a href="#99"> 99: </a></span></span><span class="l"><a href="#100">100: </a></span></span><span class="l"><a href="#101">101: </a></span></span><span class="l"><a href="#102">102: </a></span></span><span class="l"><a href="#103">103: </a></span><span class="l"><a href="#104">104: </a></span><span class="l"><a href="#105">105: </a></span><span class="l"><a href="#106">106: </a></span></span><span class="l"><a href="#107">107: </a></span></span><span class="l"><a href="#108">108: </a></span></span><span class="l"><a href="#109">109: </a></span></span><span class="l"><a href="#110">110: </a></span><span class="l"><a href="#111">111: </a></span><span class="l"><a href="#112">112: </a></span><span class="l"><a href="#113">113: </a></span></span><span class="l"><a href="#114">114: </a></span></span><span class="l"><a href="#115">115: </a></span></span><span class="l"><a href="#116">116: </a></span></span><span class="l"><a href="#117">117: </a></span></span><span class="l"><a href="#118">118: </a></span></span><span class="l"><a href="#119">119: </a></span></span><span class="l"><a href="#120">120: </a></span><span class="l"><a href="#121">121: </a></span><span class="l"><a href="#122">122: </a></span><span class="l"><a href="#123">123: </a></span></span><span class="l"><a href="#124">124: </a></span></span><span class="l"><a href="#125">125: </a></span></span><span class="l"><a href="#126">126: </a></span></span><span class="l"><a href="#127">127: </a></span></span><span class="l"><a href="#128">128: </a></span></span><span class="l"><a href="#129">129: </a></span></span><span class="l"><a href="#130">130: </a></span><span class="l"><a href="#131">131: </a></span><span class="l"><a href="#132">132: </a></span><span class="l"><a href="#133">133: </a></span><span class="l"><a href="#134">134: </a></span><span class="l"><a href="#135">135: </a></span><span class="l"><a href="#136">136: </a></span></code></pre>
<pre class="code"><code><span id="1" class="l"><span class="xlang">&lt;?php</span>
</span><span id="2" class="l">
</span><span id="3" class="l"><span class="php-keyword1">namespace</span> splitbrain\PHPArchive;
</span><span id="4" class="l">
</span><span id="5" class="l"><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> Archive
</span><span id="6" class="l">{
</span><span id="7" class="l">
</span><span id="8" class="l"> <span class="php-keyword1">const</span> COMPRESS_AUTO = -<span class="php-num">1</span>;
</span><span id="9" class="l"> <span class="php-keyword1">const</span> COMPRESS_NONE = <span class="php-num">0</span>;
</span><span id="10" class="l"> <span class="php-keyword1">const</span> COMPRESS_GZIP = <span class="php-num">1</span>;
</span><span id="11" class="l"> <span class="php-keyword1">const</span> COMPRESS_BZIP = <span class="php-num">2</span>;
</span><span id="12" class="l">
</span><span id="13" class="l"> <span class="php-comment">/** @var callable */</span>
</span><span id="14" class="l"> <span class="php-keyword1">protected</span> <span class="php-var">$callback</span>;
</span><span id="15" class="l">
</span><span id="16" class="l"> <span class="php-comment">/**
</span></span><span id="17" class="l"><span class="php-comment"> * Set the compression level and type
</span></span><span id="18" class="l"><span class="php-comment"> *
</span></span><span id="19" class="l"><span class="php-comment"> * @param int $level Compression level (0 to 9)
</span></span><span id="20" class="l"><span class="php-comment"> * @param int $type Type of compression to use (use COMPRESS_* constants)
</span></span><span id="21" class="l"><span class="php-comment"> * @throws ArchiveIllegalCompressionException
</span></span><span id="22" class="l"><span class="php-comment"> */</span>
</span><span id="23" class="l"> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setCompression(<span class="php-var">$level</span> = <span class="php-num">9</span>, <span class="php-var">$type</span> = Archive::COMPRESS_AUTO);
</span><span id="24" class="l">
</span><span id="25" class="l"> <span class="php-comment">/**
</span></span><span id="26" class="l"><span class="php-comment"> * Open an existing archive file for reading
</span></span><span id="27" class="l"><span class="php-comment"> *
</span></span><span id="28" class="l"><span class="php-comment"> * @param string $file
</span></span><span id="29" class="l"><span class="php-comment"> * @throws ArchiveIOException
</span></span><span id="30" class="l"><span class="php-comment"> */</span>
</span><span id="31" class="l"> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> open(<span class="php-var">$file</span>);
</span><span id="32" class="l">
</span><span id="33" class="l"> <span class="php-comment">/**
</span></span><span id="34" class="l"><span class="php-comment"> * Read the contents of an archive
</span></span><span id="35" class="l"><span class="php-comment"> *
</span></span><span id="36" class="l"><span class="php-comment"> * This function lists the files stored in the archive, and returns an indexed array of FileInfo objects
</span></span><span id="37" class="l"><span class="php-comment"> *
</span></span><span id="38" class="l"><span class="php-comment"> * The archive is closed afer reading the contents, because rewinding is not possible in bzip2 streams.
</span></span><span id="39" class="l"><span class="php-comment"> * Reopen the file with open() again if you want to do additional operations
</span></span><span id="40" class="l"><span class="php-comment"> *
</span></span><span id="41" class="l"><span class="php-comment"> * @return FileInfo[]
</span></span><span id="42" class="l"><span class="php-comment"> */</span>
</span><span id="43" class="l"> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> contents();
</span><span id="44" class="l">
</span><span id="45" class="l"> <span class="php-comment">/**
</span></span><span id="46" class="l"><span class="php-comment"> * Extract an existing archive
</span></span><span id="47" class="l"><span class="php-comment"> *
</span></span><span id="48" class="l"><span class="php-comment"> * The $strip parameter allows you to strip a certain number of path components from the filenames
</span></span><span id="49" class="l"><span class="php-comment"> * found in the archive file, similar to the --strip-components feature of GNU tar. This is triggered when
</span></span><span id="50" class="l"><span class="php-comment"> * an integer is passed as $strip.
</span></span><span id="51" class="l"><span class="php-comment"> * Alternatively a fixed string prefix may be passed in $strip. If the filename matches this prefix,
</span></span><span id="52" class="l"><span class="php-comment"> * the prefix will be stripped. It is recommended to give prefixes with a trailing slash.
</span></span><span id="53" class="l"><span class="php-comment"> *
</span></span><span id="54" class="l"><span class="php-comment"> * By default this will extract all files found in the archive. You can restrict the output using the $include
</span></span><span id="55" class="l"><span class="php-comment"> * and $exclude parameter. Both expect a full regular expression (including delimiters and modifiers). If
</span></span><span id="56" class="l"><span class="php-comment"> * $include is set, only files that match this expression will be extracted. Files that match the $exclude
</span></span><span id="57" class="l"><span class="php-comment"> * expression will never be extracted. Both parameters can be used in combination. Expressions are matched against
</span></span><span id="58" class="l"><span class="php-comment"> * stripped filenames as described above.
</span></span><span id="59" class="l"><span class="php-comment"> *
</span></span><span id="60" class="l"><span class="php-comment"> * The archive is closed afterwards. Reopen the file with open() again if you want to do additional operations
</span></span><span id="61" class="l"><span class="php-comment"> *
</span></span><span id="62" class="l"><span class="php-comment"> * @param string $outdir the target directory for extracting
</span></span><span id="63" class="l"><span class="php-comment"> * @param int|string $strip either the number of path components or a fixed prefix to strip
</span></span><span id="64" class="l"><span class="php-comment"> * @param string $exclude a regular expression of files to exclude
</span></span><span id="65" class="l"><span class="php-comment"> * @param string $include a regular expression of files to include
</span></span><span id="66" class="l"><span class="php-comment"> * @throws ArchiveIOException
</span></span><span id="67" class="l"><span class="php-comment"> * @return array
</span></span><span id="68" class="l"><span class="php-comment"> */</span>
</span><span id="69" class="l"> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">extract</span>(<span class="php-var">$outdir</span>, <span class="php-var">$strip</span> = <span class="php-quote">''</span>, <span class="php-var">$exclude</span> = <span class="php-quote">''</span>, <span class="php-var">$include</span> = <span class="php-quote">''</span>);
</span><span id="70" class="l">
</span><span id="71" class="l"> <span class="php-comment">/**
</span></span><span id="72" class="l"><span class="php-comment"> * Create a new archive file
</span></span><span id="73" class="l"><span class="php-comment"> *
</span></span><span id="74" class="l"><span class="php-comment"> * If $file is empty, the archive file will be created in memory
</span></span><span id="75" class="l"><span class="php-comment"> *
</span></span><span id="76" class="l"><span class="php-comment"> * @param string $file
</span></span><span id="77" class="l"><span class="php-comment"> */</span>
</span><span id="78" class="l"> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> create(<span class="php-var">$file</span> = <span class="php-quote">''</span>);
</span><span id="79" class="l">
</span><span id="80" class="l"> <span class="php-comment">/**
</span></span><span id="81" class="l"><span class="php-comment"> * Add a file to the current archive using an existing file in the filesystem
</span></span><span id="82" class="l"><span class="php-comment"> *
</span></span><span id="83" class="l"><span class="php-comment"> * @param string $file path to the original file
</span></span><span id="84" class="l"><span class="php-comment"> * @param string|FileInfo $fileinfo either the name to us in archive (string) or a FileInfo oject with all meta data, empty to take from original
</span></span><span id="85" class="l"><span class="php-comment"> * @throws ArchiveIOException
</span></span><span id="86" class="l"><span class="php-comment"> */</span>
</span><span id="87" class="l"> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> addFile(<span class="php-var">$file</span>, <span class="php-var">$fileinfo</span> = <span class="php-quote">''</span>);
</span><span id="88" class="l">
</span><span id="89" class="l"> <span class="php-comment">/**
</span></span><span id="90" class="l"><span class="php-comment"> * Add a file to the current archive using the given $data as content
</span></span><span id="91" class="l"><span class="php-comment"> *
</span></span><span id="92" class="l"><span class="php-comment"> * @param string|FileInfo $fileinfo either the name to us in archive (string) or a FileInfo oject with all meta data
</span></span><span id="93" class="l"><span class="php-comment"> * @param string $data binary content of the file to add
</span></span><span id="94" class="l"><span class="php-comment"> * @throws ArchiveIOException
</span></span><span id="95" class="l"><span class="php-comment"> */</span>
</span><span id="96" class="l"> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> addData(<span class="php-var">$fileinfo</span>, <span class="php-var">$data</span>);
</span><span id="97" class="l">
</span><span id="98" class="l"> <span class="php-comment">/**
</span></span><span id="99" class="l"><span class="php-comment"> * Close the archive, close all file handles
</span></span><span id="100" class="l"><span class="php-comment"> *
</span></span><span id="101" class="l"><span class="php-comment"> * After a call to this function no more data can be added to the archive, for
</span></span><span id="102" class="l"><span class="php-comment"> * read access no reading is allowed anymore
</span></span><span id="103" class="l"><span class="php-comment"> */</span>
</span><span id="104" class="l"> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> close();
</span><span id="105" class="l">
</span><span id="106" class="l"> <span class="php-comment">/**
</span></span><span id="107" class="l"><span class="php-comment"> * Returns the created in-memory archive data
</span></span><span id="108" class="l"><span class="php-comment"> *
</span></span><span id="109" class="l"><span class="php-comment"> * This implicitly calls close() on the Archive
</span></span><span id="110" class="l"><span class="php-comment"> */</span>
</span><span id="111" class="l"> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getArchive();
</span><span id="112" class="l">
</span><span id="113" class="l"> <span class="php-comment">/**
</span></span><span id="114" class="l"><span class="php-comment"> * Save the created in-memory archive data
</span></span><span id="115" class="l"><span class="php-comment"> *
</span></span><span id="116" class="l"><span class="php-comment"> * Note: It is more memory effective to specify the filename in the create() function and
</span></span><span id="117" class="l"><span class="php-comment"> * let the library work on the new file directly.
</span></span><span id="118" class="l"><span class="php-comment"> *
</span></span><span id="119" class="l"><span class="php-comment"> * @param string $file
</span></span><span id="120" class="l"><span class="php-comment"> */</span>
</span><span id="121" class="l"> <span class="php-keyword1">abstract</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> save(<span class="php-var">$file</span>);
</span><span id="122" class="l">
</span><span id="123" class="l"> <span class="php-comment">/**
</span></span><span id="124" class="l"><span class="php-comment"> * Set a callback function to be called whenever a file is added or extracted.
</span></span><span id="125" class="l"><span class="php-comment"> *
</span></span><span id="126" class="l"><span class="php-comment"> * The callback is called with a FileInfo object as parameter. You can use this to show progress
</span></span><span id="127" class="l"><span class="php-comment"> * info during an operation.
</span></span><span id="128" class="l"><span class="php-comment"> *
</span></span><span id="129" class="l"><span class="php-comment"> * @param callable $callback
</span></span><span id="130" class="l"><span class="php-comment"> */</span>
</span><span id="131" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> setCallback(<span class="php-var">$callback</span>)
</span><span id="132" class="l"> {
</span><span id="133" class="l"> <span class="php-var">$this</span>-&gt;callback = <span class="php-var">$callback</span>;
</span><span id="134" class="l"> }
</span><span id="135" class="l">}
</span><span id="136" class="l"></span></code></pre>
<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>
Reference in New Issue View Git Blame Copy Permalink