<!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 files from a directory by glob pattern</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ziparchive.addfromstring.html">ZipArchive::addFromString</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ziparchive.addpattern.html">ZipArchive::addPattern</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.addglob" class="refentry">
<div class="refnamediv">
<h1 class="refname">ZipArchive::addGlob</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL zip >= 1.9.0)</p><p class="refpurpose"><span class="refname">ZipArchive::addGlob</span> — <span class="dc-title">Add files from a directory by glob pattern</span></p>
</div>
<div class="refsect1 description" id="refsect1-ziparchive.addglob-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ZipArchive::addGlob</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$pattern</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code><span class="initializer"> = array()</span></span>
]] )</div>
<p class="para rdfs-comment">
Add files from a directory which match the glob <em><code class="parameter">pattern</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-ziparchive.addglob-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">pattern</code></em></span>
<dd>
<p class="para">
A <span class="function"><a href="function.glob.html" class="function">glob()</a></span> pattern against which files will be matched.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
A bit mask of <em>glob()</em> flags.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">options</code></em></span>
<dd>
<p class="para">
An associative array of options. Available options are:
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<em>"add_path"</em>
</p>
<p class="para">
Prefix to prepend when translating to the local path of the file within
the archive. This is applied after any remove operations defined by the
<em>"remove_path"</em> or <em>"remove_all_path"</em>
options.
</p>
</li>
<li class="listitem">
<p class="para">
<em>"remove_path"</em>
</p>
<p class="para">
Prefix to remove from matching file paths before adding to the archive.
</p>
</li>
<li class="listitem">
<p class="para">
<em>"remove_all_path"</em>
</p>
<p class="para">
<strong><code>TRUE</code></strong> to use the file name only and add to the root of the archive.
</p>
</li>
</ul>
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-ziparchive.addglob-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.addglob-examples">
<h3 class="title">Examples</h3>
<div class="example" id="ziparchive.addglob.example.basic">
<p><strong>Example #1 <span class="methodname"><strong>ZipArchive::addGlob()</strong></span> example</strong></p>
<div class="example-contents"><p>
Add all php scripts and text files from current working directory
</p></div>
<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">$ret </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">'application.zip'</span><span style="color: #007700">, </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">OVERWRITE</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">!== </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">'Failed with code %d'</span><span style="color: #007700">, </span><span style="color: #0000BB">$ret</span><span style="color: #007700">);<br />} else {<br /> </span><span style="color: #0000BB">$options </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'add_path' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'sources/'</span><span style="color: #007700">, </span><span style="color: #DD0000">'remove_all_path' </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">addGlob</span><span style="color: #007700">(</span><span style="color: #DD0000">'*.{php,txt}'</span><span style="color: #007700">, </span><span style="color: #0000BB">GLOB_BRACE</span><span style="color: #007700">, </span><span style="color: #0000BB">$options</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 />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-ziparchive.addglob-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="ziparchive.addfile.html" class="methodname" rel="rdfs-seeAlso">ZipArchive::addFile()</a> - Adds a file to a ZIP archive from the given path</span></li>
<li class="member"> <span class="methodname"><a href="ziparchive.addpattern.html" class="methodname" rel="rdfs-seeAlso">ZipArchive::addPattern()</a> - Add files from a directory by PCRE pattern</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="ziparchive.addfromstring.html">ZipArchive::addFromString</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ziparchive.addpattern.html">ZipArchive::addPattern</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>
