<!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 phar archive</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.addfile.html">Phar::addFile</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.apiversion.html">Phar::apiVersion</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phar.addfromstring" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::addFromString</h1>
<p class="verinfo">(Unknown)</p><p class="refpurpose"><span class="refname">Phar::addFromString</span> — <span class="dc-title">Add a file from the filesystem to the phar archive</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.addfromstring-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"><strong>Phar::addFromString</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$localname</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$contents</code></span>
)</div>
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">This
method requires the <var class="filename">php.ini</var> setting <em>phar.readonly</em> to be
set to <em>0</em> in order to work for <a href="class.phar.html" class="classname">Phar</a>
objects. Otherwise, a <a href="class.pharexception.html" class="classname">PharException</a> will be thrown.</p></p></blockquote>
<p class="para">
With this method, any string can be added to the phar archive.
The file will be stored in the archive with <em>localname</em> as its
path. This method is similar to <span class="function"><a href="ziparchive.addfromstring.html" class="function">ZipArchive::addFromString()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.addfromstring-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<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>
<dt>
<span class="term"><em><code class="parameter">contents</code></em></span>
<dd>
<p class="para">
The file contents to store
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.addfromstring-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-phar.addfromstring-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-658">
<p><strong>Example #1 A <span class="function"><strong>Phar::addFromString()</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">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/phar.phar'</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$a</span><span style="color: #007700">-></span><span style="color: #0000BB">addFromString</span><span style="color: #007700">(</span><span style="color: #DD0000">'path/to/file.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'my simple file'</span><span style="color: #007700">);<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">'path/to/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">// to add contents from a stream handle for large files, use offsetSet()<br /> </span><span style="color: #0000BB">$c </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/hugefile.bin'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$a</span><span style="color: #007700">[</span><span style="color: #DD0000">'largefile.bin'</span><span style="color: #007700">] = </span><span style="color: #0000BB">$c</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$c</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-phar.addfromstring-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phar.offsetset.html" class="function" rel="rdfs-seeAlso">Phar::offsetSet()</a> - set the contents of an internal file to those of an external file</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="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="phar.addemptydir.html" class="function" rel="rdfs-seeAlso">Phar::addEmptyDir()</a> - Add an empty directory to the phar 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="phar.addfile.html">Phar::addFile</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.apiversion.html">Phar::apiVersion</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
