<!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>Test whether an archive is broken (incomplete)</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rararchive.getentry.html">RarArchive::getEntry</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rararchive.issolid.html">RarArchive::isSolid</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.isbroken" class="refentry">
<div class="refnamediv">
<h1 class="refname">RarArchive::isBroken</h1>
<h1 class="refname">rar_broken_is</h1>
<p class="verinfo">(PECL rar >= 3.0.0)</p><p class="refpurpose"><span class="refname">RarArchive::isBroken</span> -- <span class="refname">rar_broken_is</span> — <span class="dc-title">Test whether an archive is broken (incomplete)</span></p>
</div>
<div class="refsect1 description" id="refsect1-rararchive.isbroken-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::isBroken</strong></span>
( <span class="methodparam">void</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_broken_is</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>
)</div>
<p class="para rdfs-comment">
This function determines whether an archive is incomplete, i.e., if a volume is missing or a volume is truncated.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-rararchive.isbroken-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>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-rararchive.isbroken-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if the archive is broken, <strong><code>FALSE</code></strong> otherwise. This function may also
return <strong><code>FALSE</code></strong> if the passed file has already been closed. The only way
to tell the two cases apart is to enable
exceptions with <span class="methodname"><a href="rarexception.setusingexceptions.html" class="methodname">RarException::setUsingExceptions()</a></span>; however,
this should be unnecessary as a program should not operate on closed files.
</p>
</div>
<div class="refsect1 examples" id="refsect1-rararchive.isbroken-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-753">
<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 is used to omit notice */<br /></span><span style="color: #0000BB">$arch </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">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$arch</span><span style="color: #007700">-></span><span style="color: #0000BB">isBroken</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>
bool(true)
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-754">
<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 is used to omit notice */<br /></span><span style="color: #0000BB">$arch </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">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">rar_broken_is</span><span style="color: #007700">(</span><span style="color: #0000BB">$arch</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.isbroken-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="rararchive.setallowbroken.html" class="methodname" rel="rdfs-seeAlso">RarArchive::setAllowBroken()</a> - Whether opening broken archives is allowed</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.getentry.html">RarArchive::getEntry</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rararchive.issolid.html">RarArchive::isSolid</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>
