<!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>Get text representation</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rararchive.setallowbroken.html">RarArchive::setAllowBroken</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.rarentry.html">RarEntry</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.tostring" class="refentry">
<div class="refnamediv">
<h1 class="refname">RarArchive::__toString</h1>
<p class="verinfo">(PECL rar >= 2.0.0)</p><p class="refpurpose"><span class="refname">RarArchive::__toString</span> — <span class="dc-title">Get text representation</span></p>
</div>
<div class="refsect1 description" id="refsect1-rararchive.tostring-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>RarArchive::__toString</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Provides a string representation for this <span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span> object. It currently shows
the full path name of the archive volume that was opened and whether the resource is valid
or was already closed through a call to <span class="methodname"><a href="rararchive.close.html" class="methodname">RarArchive::close()</a></span>.
</p>
<p class="para">
This method may be used only for debugging purposes, as there are no guarantees as to which
information the result contains or how it is formatted.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-rararchive.tostring-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-rararchive.tostring-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A textual representation of this <span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span> object.
The content of this representation is unspecified.
</p>
</div>
<div class="refsect1 examples" id="refsect1-rararchive.tostring-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-762">
<p><strong>Example #1 <span class="methodname"><strong>RarArchive::__toString()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$rar_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: #DD0000">'latest_winrar.rar'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">.</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br />echo </span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">.</span><span style="color: #DD0000">"\n"</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>
RAR Archive "D:\php_rar\trunk\tests\latest_winrar.rar"
RAR Archive "D:\php_rar\trunk\tests\latest_winrar.rar" (closed)
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rararchive.setallowbroken.html">RarArchive::setAllowBroken</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.rarentry.html">RarEntry</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>
