<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Add a file from the filesystem to the tar/zip archive</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phardata.addemptydir.html">PharData::addEmptyDir</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phardata.addfromstring.html">PharData::addFromString</a></div>
<div class="up"><a href="class.phardata.html">PharData</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phardata.addfile" class="refentry">
<div class="refnamediv">
<h1 class="refname">PharData::addFile</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">PharData::addFile</span> — <span class="dc-title">Add a file from the filesystem to the tar/zip archive</span></p>
</div>
<div class="refsect1 description" id="refsect1-phardata.addfile-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><a href="phar.addfile.html" class="methodname">Phar::addFile</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$file</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$localname</code></span>
] )</div>
<p class="para rdfs-comment">
With this method, any file or URL can be added to the tar/zip archive. If
the optional second parameter <em>localname</em> is specified,
the file will be stored in the archive with that name, otherwise the
<em>file</em> parameter is used as the path to store within
the archive. URLs must have a localname or an exception is thrown.
This method is similar to <span class="function"><a href="ziparchive.addfile.html" class="function">ZipArchive::addFile()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phardata.addfile-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">file</code></em></span>
<dd>
<p class="para">
Full or relative path to a file on disk to be added
to the phar archive.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">localname</code></em></span>
<dd>
<p class="para">
Path that the file will be stored in the archive.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phardata.addfile-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
no return value, exception is thrown on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phardata.addfile-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-706">
<p><strong>Example #1 A <span class="function"><strong>PharData::addFile()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">try {<br /> </span><span style="color: #0000BB">$a </span><span style="color: #007700">= new </span><span style="color: #0000BB">PharData</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/my.tar'</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$a</span><span style="color: #007700">-></span><span style="color: #0000BB">addFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'/full/path/to/file'</span><span style="color: #007700">);<br /> </span><span style="color: #FF8000">// demonstrates how this file is stored<br /> </span><span style="color: #0000BB">$b </span><span style="color: #007700">= </span><span style="color: #0000BB">$a</span><span style="color: #007700">[</span><span style="color: #DD0000">'full/path/to/file'</span><span style="color: #007700">]-></span><span style="color: #0000BB">getContent</span><span style="color: #007700">();<br /><br /> </span><span style="color: #0000BB">$a</span><span style="color: #007700">-></span><span style="color: #0000BB">addFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'/full/path/to/file'</span><span style="color: #007700">, </span><span style="color: #DD0000">'my/file.txt'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$c </span><span style="color: #007700">= </span><span style="color: #0000BB">$a</span><span style="color: #007700">[</span><span style="color: #DD0000">'my/file.txt'</span><span style="color: #007700">]-></span><span style="color: #0000BB">getContent</span><span style="color: #007700">();<br /><br /> </span><span style="color: #FF8000">// demonstrate URL usage<br /> </span><span style="color: #0000BB">$a</span><span style="color: #007700">-></span><span style="color: #0000BB">addFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://www.example.com'</span><span style="color: #007700">, </span><span style="color: #DD0000">'example.html'</span><span style="color: #007700">);<br />} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// handle errors here<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phardata.addfile-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phardata.offsetset.html" class="function" rel="rdfs-seeAlso">PharData::offsetSet()</a> - set the contents of a file within the tar/zip to those of an external file or string</span></li>
<li class="member"> <span class="function"><a href="phar.addfile.html" class="function" rel="rdfs-seeAlso">Phar::addFile()</a> - Add a file from the filesystem to the phar archive</span></li>
<li class="member"> <span class="function"><a href="phardata.addfromstring.html" class="function" rel="rdfs-seeAlso">PharData::addFromString()</a> - Add a file from the filesystem to the tar/zip archive</span></li>
<li class="member"> <span class="function"><a href="phardata.addemptydir.html" class="function" rel="rdfs-seeAlso">PharData::addEmptyDir()</a> - Add an empty directory to the tar/zip archive</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phardata.addemptydir.html">PharData::addEmptyDir</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phardata.addfromstring.html">PharData::addFromString</a></div>
<div class="up"><a href="class.phardata.html">PharData</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
