<!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>Whether opening broken archives is allowed</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rararchive.open.html">RarArchive::open</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rararchive.tostring.html">RarArchive::__toString</a></div>
<div class="up"><a href="class.rararchive.html">RarArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="rararchive.setallowbroken" class="refentry">
<div class="refnamediv">
<h1 class="refname">RarArchive::setAllowBroken</h1>
<p class="verinfo">(PECL rar >= 3.0.0)</p><p class="refpurpose"><span class="refname">RarArchive::setAllowBroken</span> — <span class="dc-title">Whether opening broken archives is allowed</span></p>
</div>
<div class="refsect1 description" id="refsect1-rararchive.setallowbroken-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style (method):</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>RarArchive::setAllowBroken</strong></span>
( <span class="methodparam"><span class="type">bool</span> <code class="parameter">$allow_broken</code></span>
)</div>
<p class="para rdfs-comment">Procedural style:</p>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>rar_allow_broken_set</strong></span>
( <span class="methodparam"><span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span> <code class="parameter">$rarfile</code></span>
, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$allow_broken</code></span>
)</div>
<p class="para rdfs-comment">
This method defines whether broken archives can be read or all the operations that
attempt to extract the archive entries will fail. Broken archives are archives for
which no error is detected when the file is opened but an error occurs when reading
the entries.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-rararchive.setallowbroken-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">rarfile</code></em></span>
<dd>
<p class="para">
A <span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span> object, opened with <span class="function"><a href="rararchive.open.html" class="function">rar_open()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">allow_broken</code></em></span>
<dd>
<p class="para">
Whether to allow reading broken files (<strong><code>TRUE</code></strong>) or not (<strong><code>FALSE</code></strong>).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-rararchive.setallowbroken-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> or <strong><code>FALSE</code></strong> on failure. It will only fail if the file has
already been closed.
</p>
</div>
<div class="refsect1 examples" id="refsect1-rararchive.setallowbroken-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-760">
<p><strong>Example #1 Object oriented style</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">function </span><span style="color: #0000BB">retnull</span><span style="color: #007700">() { return </span><span style="color: #0000BB">null</span><span style="color: #007700">; }<br /></span><span style="color: #0000BB">$file </span><span style="color: #007700">= </span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">) . </span><span style="color: #DD0000">"/multi_broken.part1.rar"</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">/* Third argument omits "volume not found" message */<br /></span><span style="color: #0000BB">$a </span><span style="color: #007700">= </span><span style="color: #0000BB">RarArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">null</span><span style="color: #007700">, </span><span style="color: #DD0000">'retnull'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$a</span><span style="color: #007700">-></span><span style="color: #0000BB">setAllowBroken</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br />foreach (</span><span style="color: #0000BB">$a</span><span style="color: #007700">-></span><span style="color: #0000BB">getEntries</span><span style="color: #007700">() as </span><span style="color: #0000BB">$e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$e</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">count</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
RarEntry for file "file1.txt" (52b28202)
int(1)
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-761">
<p><strong>Example #2 Procedural style</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">function </span><span style="color: #0000BB">retnull</span><span style="color: #007700">() { return </span><span style="color: #0000BB">null</span><span style="color: #007700">; }<br /></span><span style="color: #0000BB">$file </span><span style="color: #007700">= </span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">) . </span><span style="color: #DD0000">"/multi_broken.part1.rar"</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">/* Third argument omits "volume not found" message */<br /></span><span style="color: #0000BB">$a </span><span style="color: #007700">= </span><span style="color: #0000BB">rar_open</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">null</span><span style="color: #007700">, </span><span style="color: #DD0000">'retnull'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">rar_allow_broken_set</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br />foreach (</span><span style="color: #0000BB">rar_list</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</span><span style="color: #007700">) as </span><span style="color: #0000BB">$e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$e</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">count</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</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-rararchive.setallowbroken-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="rararchive.isbroken.html" class="methodname" rel="rdfs-seeAlso">RarArchive::isBroken()</a> - Test whether an archive is broken (incomplete)</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="rararchive.open.html">RarArchive::open</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rararchive.tostring.html">RarArchive::__toString</a></div>
<div class="up"><a href="class.rararchive.html">RarArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
