<!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 to a ZIP archive using its contents</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ziparchive.addfile.html">ZipArchive::addFile</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ziparchive.addglob.html">ZipArchive::addGlob</a></div>
<div class="up"><a href="class.ziparchive.html">ZipArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ziparchive.addfromstring" class="refentry">
<div class="refnamediv">
<h1 class="refname">ZipArchive::addFromString</h1>
<p class="verinfo">(PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0)</p><p class="refpurpose"><span class="refname">ZipArchive::addFromString</span> — <span class="dc-title">Add a file to a ZIP archive using its contents</span></p>
</div>
<div class="refsect1 description" id="refsect1-ziparchive.addfromstring-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ZipArchive::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>
<p class="para rdfs-comment">
Add a file to a ZIP archive using its contents.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">For maximum portability, it is recommended to always use forward slashes (<em>/</em>) as directory separator in ZIP filenames.</span></p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-ziparchive.addfromstring-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">localname</code></dt>
<dd>
<p class="para">
The name of the entry to create.
</p>
</dd>
<dt>
<code class="parameter">contents</code></dt>
<dd>
<p class="para">
The contents to use to create the entry. It is used in a binary
safe mode.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-ziparchive.addfromstring-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-ziparchive.addfromstring-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-866">
<p><strong>Example #1 Add an entry to a new archive</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.zip'</span><span style="color: #007700">, </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">CREATE</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$res </span><span style="color: #007700">=== </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">addFromString</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'file content goes here'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /> echo </span><span style="color: #DD0000">'ok'</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">'failed'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-867">
<p><strong>Example #2 Add file to a directory inside an archive</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.zip'</span><span style="color: #007700">) === </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">addFromString</span><span style="color: #007700">(</span><span style="color: #DD0000">'dir/test.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'file content goes here'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /> echo </span><span style="color: #DD0000">'ok'</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">'failed'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ziparchive.addfile.html">ZipArchive::addFile</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ziparchive.addglob.html">ZipArchive::addGlob</a></div>
<div class="up"><a href="class.ziparchive.html">ZipArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
