<!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>The RarEntry class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rararchive.tostring.html">RarArchive::__toString</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rarentry.extract.html">RarEntry::extract</a></div>
<div class="up"><a href="book.rar.html">Rar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.rarentry" class="reference">
<h1 class="title">The <a href="class.rarentry.html" class="classname">RarEntry</a> class</h1>
<div class="partintro"><p class="verinfo">(PECL rar >= 0.1)</p>
<div class="section" id="rarentry.intro">
<h2 class="title">Introduction</h2>
<p class="para">
A RAR entry, representing a directory or a compressed file inside a RAR archive.
</p>
</div>
<div class="section" id="rarentry.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<span class="modifier">final</span>
<strong class="classname">RarEntry</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.host-msdos"><var class="varname">HOST_MSDOS</var></a></var>
<span class="initializer"> = 0</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.host-os2"><var class="varname">HOST_OS2</var></a></var>
<span class="initializer"> = 1</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.host-win32"><var class="varname">HOST_WIN32</var></a></var>
<span class="initializer"> = 2</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.host-unix"><var class="varname">HOST_UNIX</var></a></var>
<span class="initializer"> = 3</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.host-macos"><var class="varname">HOST_MACOS</var></a></var>
<span class="initializer"> = 4</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.host-beos"><var class="varname">HOST_BEOS</var></a></var>
<span class="initializer"> = 5</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-readonly"><var class="varname">ATTRIBUTE_WIN_READONLY</var></a></var>
<span class="initializer"> = 1</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-hidden"><var class="varname">ATTRIBUTE_WIN_HIDDEN</var></a></var>
<span class="initializer"> = 2</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-system"><var class="varname">ATTRIBUTE_WIN_SYSTEM</var></a></var>
<span class="initializer"> = 4</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-directory"><var class="varname">ATTRIBUTE_WIN_DIRECTORY</var></a></var>
<span class="initializer"> = 16</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-archive"><var class="varname">ATTRIBUTE_WIN_ARCHIVE</var></a></var>
<span class="initializer"> = 32</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-device"><var class="varname">ATTRIBUTE_WIN_DEVICE</var></a></var>
<span class="initializer"> = 64</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-normal"><var class="varname">ATTRIBUTE_WIN_NORMAL</var></a></var>
<span class="initializer"> = 128</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-temporary"><var class="varname">ATTRIBUTE_WIN_TEMPORARY</var></a></var>
<span class="initializer"> = 256</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-sparse-file"><var class="varname">ATTRIBUTE_WIN_SPARSE_FILE</var></a></var>
<span class="initializer"> = 512</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-reparse-point"><var class="varname">ATTRIBUTE_WIN_REPARSE_POINT</var></a></var>
<span class="initializer"> = 1024</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-compressed"><var class="varname">ATTRIBUTE_WIN_COMPRESSED</var></a></var>
<span class="initializer"> = 2048</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-offline"><var class="varname">ATTRIBUTE_WIN_OFFLINE</var></a></var>
<span class="initializer"> = 4096</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-not-content-indexed"><var class="varname">ATTRIBUTE_WIN_NOT_CONTENT_INDEXED</var></a></var>
<span class="initializer"> = 8192</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-encrypted"><var class="varname">ATTRIBUTE_WIN_ENCRYPTED</var></a></var>
<span class="initializer"> = 16384</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-win-virtual"><var class="varname">ATTRIBUTE_WIN_VIRTUAL</var></a></var>
<span class="initializer"> = 65536</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-world-execute"><var class="varname">ATTRIBUTE_UNIX_WORLD_EXECUTE</var></a></var>
<span class="initializer"> = 1</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-world-write"><var class="varname">ATTRIBUTE_UNIX_WORLD_WRITE</var></a></var>
<span class="initializer"> = 2</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-world-read"><var class="varname">ATTRIBUTE_UNIX_WORLD_READ</var></a></var>
<span class="initializer"> = 4</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-group-execute"><var class="varname">ATTRIBUTE_UNIX_GROUP_EXECUTE</var></a></var>
<span class="initializer"> = 8</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-group-write"><var class="varname">ATTRIBUTE_UNIX_GROUP_WRITE</var></a></var>
<span class="initializer"> = 16</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-group-read"><var class="varname">ATTRIBUTE_UNIX_GROUP_READ</var></a></var>
<span class="initializer"> = 32</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-owner-execute"><var class="varname">ATTRIBUTE_UNIX_OWNER_EXECUTE</var></a></var>
<span class="initializer"> = 64</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-owner-write"><var class="varname">ATTRIBUTE_UNIX_OWNER_WRITE</var></a></var>
<span class="initializer"> = 128</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-owner-read"><var class="varname">ATTRIBUTE_UNIX_OWNER_READ</var></a></var>
<span class="initializer"> = 256</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-sticky"><var class="varname">ATTRIBUTE_UNIX_STICKY</var></a></var>
<span class="initializer"> = 512</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-setgid"><var class="varname">ATTRIBUTE_UNIX_SETGID</var></a></var>
<span class="initializer"> = 1024</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-setuid"><var class="varname">ATTRIBUTE_UNIX_SETUID</var></a></var>
<span class="initializer"> = 2048</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-final-quartet"><var class="varname">ATTRIBUTE_UNIX_FINAL_QUARTET</var></a></var>
<span class="initializer"> = 61440</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-fifo"><var class="varname">ATTRIBUTE_UNIX_FIFO</var></a></var>
<span class="initializer"> = 4096</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-char-dev"><var class="varname">ATTRIBUTE_UNIX_CHAR_DEV</var></a></var>
<span class="initializer"> = 8192</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-directory"><var class="varname">ATTRIBUTE_UNIX_DIRECTORY</var></a></var>
<span class="initializer"> = 16384</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-block-dev"><var class="varname">ATTRIBUTE_UNIX_BLOCK_DEV</var></a></var>
<span class="initializer"> = 24576</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-regular-file"><var class="varname">ATTRIBUTE_UNIX_REGULAR_FILE</var></a></var>
<span class="initializer"> = 32768</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-sym-link"><var class="varname">ATTRIBUTE_UNIX_SYM_LINK</var></a></var>
<span class="initializer"> = 40960</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.rarentry.html#rarentry.constants.attribute-unix-socket"><var class="varname">ATTRIBUTE_UNIX_SOCKET</var></a></var>
<span class="initializer"> = 49152</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="rarentry.extract.html" class="methodname">extract</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$dir</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$filepath</code><span class="initializer"> = ''</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</code><span class="initializer"> = NULL</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$extended_data</code><span class="initializer"> = false</span></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="rarentry.getattr.html" class="methodname">getAttr</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="rarentry.getcrc.html" class="methodname">getCrc</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="rarentry.getfiletime.html" class="methodname">getFileTime</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="rarentry.gethostos.html" class="methodname">getHostOs</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="rarentry.getmethod.html" class="methodname">getMethod</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="rarentry.getname.html" class="methodname">getName</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="rarentry.getpackedsize.html" class="methodname">getPackedSize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">resource</span> <span class="methodname"><a href="rarentry.getstream.html" class="methodname">getStream</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="rarentry.getunpackedsize.html" class="methodname">getUnpackedSize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="rarentry.getversion.html" class="methodname">getVersion</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="rarentry.isdirectory.html" class="methodname">isDirectory</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="rarentry.isencrypted.html" class="methodname">isEncrypted</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="rarentry.tostring.html" class="methodname">__toString</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
<div class="section" id="rarentry.constants">
<h2 class="title">Predefined Constants</h2>
<dl>
<dt id="rarentry.constants.host-msdos">
<span class="term"><strong><code>RarEntry::HOST_MSDOS</code></strong></span>
<dd>
<p class="para">If the return value of <span class="methodname"><a href="rarentry.gethostos.html" class="methodname">RarEntry::getHostOs()</a></span> equals this constant, MS-DOS was used to
add this entry. Use instead of <strong><code>RAR_HOST_MSDOS</code></strong>.</p>
</dd>
</dt>
<dt id="rarentry.constants.host-os2">
<span class="term"><strong><code>RarEntry::HOST_OS2</code></strong></span>
<dd>
<p class="para">If the return value of <span class="methodname"><a href="rarentry.gethostos.html" class="methodname">RarEntry::getHostOs()</a></span> equals this constant, OS/2 was used to
add this entry. Intended to replace <strong><code>RAR_HOST_OS2</code></strong>.</p>
</dd>
</dt>
<dt id="rarentry.constants.host-win32">
<span class="term"><strong><code>RarEntry::HOST_WIN32</code></strong></span>
<dd>
<p class="para">If the return value of <span class="methodname"><a href="rarentry.gethostos.html" class="methodname">RarEntry::getHostOs()</a></span> equals this constant, Microsoft Windows was used to
add this entry. Intended to replace <strong><code>RAR_HOST_WIN32</code></strong>.</p>
</dd>
</dt>
<dt id="rarentry.constants.host-unix">
<span class="term"><strong><code>RarEntry::HOST_UNIX</code></strong></span>
<dd>
<p class="para">If the return value of <span class="methodname"><a href="rarentry.gethostos.html" class="methodname">RarEntry::getHostOs()</a></span> equals this constant, an unspecified UNIX OS was used to
add this entry. Intended to replace <strong><code>RAR_HOST_UNIX</code></strong>.</p>
</dd>
</dt>
<dt id="rarentry.constants.host-macos">
<span class="term"><strong><code>RarEntry::HOST_MACOS</code></strong></span>
<dd>
<p class="para">If the return value of <span class="methodname"><a href="rarentry.gethostos.html" class="methodname">RarEntry::getHostOs()</a></span> equals this constant, Mac OS was used to
add this entry.</p>
</dd>
</dt>
<dt id="rarentry.constants.host-beos">
<span class="term"><strong><code>RarEntry::HOST_BEOS</code></strong></span>
<dd>
<p class="para">If the return value of <span class="methodname"><a href="rarentry.gethostos.html" class="methodname">RarEntry::getHostOs()</a></span> equals this constant, BeOS was used to
add this entry. Intended to replace <strong><code>RAR_HOST_BEOS</code></strong>.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-readonly">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_READONLY</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a read-only attribute. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-hidden">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_HIDDEN</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a hidden attribute. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-system">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_SYSTEM</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a system attribute. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-directory">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_DIRECTORY</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a directory attribute (entry is a directory). To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows. See also
<span class="methodname"><a href="rarentry.isdirectory.html" class="methodname">RarEntry::isDirectory()</a></span>, which also works with entries that were not added in WinRAR.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-archive">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_ARCHIVE</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with an archive attribute. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-device">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_DEVICE</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a device attribute. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-normal">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_NORMAL</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a normal file attribute (entry is NOT a directory). To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows. See also
<span class="methodname"><a href="rarentry.isdirectory.html" class="methodname">RarEntry::isDirectory()</a></span>, which also works with entries that were not added in WinRAR.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-temporary">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_TEMPORARY</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a temporary attribute. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-sparse-file">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_SPARSE_FILE</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a sparse file attribute (file is an NTFS sparse file). To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-reparse-point">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_REPARSE_POINT</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a reparse point attribute (entry is an NTFS reparse point, e.g. a
directory junction or a mount file system). To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-compressed">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_COMPRESSED</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a compressed attribute (NTFS only). To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-offline">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_OFFLINE</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with an offline attribute (entry is offline and not accessible). To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-not-content-indexed">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a not content indexed attribute (entry is to be indexed). To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-encrypted">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_ENCRYPTED</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with an encrypted attribute (NTFS only). To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-win-virtual">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_WIN_VIRTUAL</code></strong></span>
<dd>
<p class="para">Bit that represents a Windows entry with a virtual attribute. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is Microsoft Windows.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-world-execute">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE</code></strong></span>
<dd>
<p class="para">Bit that represents a UNIX entry that is world executable. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-world-write">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE</code></strong></span>
<dd>
<p class="para">Bit that represents a UNIX entry that is world writable. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-world-read">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_WORLD_READ</code></strong></span>
<dd>
<p class="para">Bit that represents a UNIX entry that is world readable. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-group-execute">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE</code></strong></span>
<dd>
<p class="para">Bit that represents a UNIX entry that is group executable. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-group-write">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE</code></strong></span>
<dd>
<p class="para">Bit that represents a UNIX entry that is group writable. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-group-read">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_GROUP_READ</code></strong></span>
<dd>
<p class="para">Bit that represents a UNIX entry that is group readable. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-owner-execute">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE</code></strong></span>
<dd>
<p class="para">Bit that represents a UNIX entry that is owner executable. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-owner-write">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE</code></strong></span>
<dd>
<p class="para">Bit that represents a UNIX entry that is owner writable. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-owner-read">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_OWNER_READ</code></strong></span>
<dd>
<p class="para">Bit that represents a UNIX entry that is owner readable. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-sticky">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_STICKY</code></strong></span>
<dd>
<p class="para">Bit that represents the UNIX sticky bit. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-setgid">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_SETGID</code></strong></span>
<dd>
<p class="para">Bit that represents the UNIX setgid attribute. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-setuid">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_SETUID</code></strong></span>
<dd>
<p class="para">Bit that represents the UNIX setuid attribute. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-final-quartet">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</code></strong></span>
<dd>
<p class="para">Mask to isolate the last four bits (nibble) of UNIX attributes
(_S_IFMT, the type of file mask). To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX and with the
constants <a href="class.rarentry.html#rarentry.constants.attribute-unix-fifo" class="link"><strong><code>RarEntry::ATTRIBUTE_UNIX_FIFO</code></strong></a>,
<a href="class.rarentry.html#rarentry.constants.attribute-unix-char-dev" class="link"><strong><code>RarEntry::ATTRIBUTE_UNIX_CHAR_DEV</code></strong></a>,
<a href="class.rarentry.html#rarentry.constants.attribute-unix-directory" class="link"><strong><code>RarEntry::ATTRIBUTE_UNIX_DIRECTORY</code></strong></a>,
<a href="class.rarentry.html#rarentry.constants.attribute-unix-block-dev" class="link"><strong><code>RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</code></strong></a>,
<a href="class.rarentry.html#rarentry.constants.attribute-unix-regular-file" class="link"><strong><code>RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</code></strong></a>,
<a href="class.rarentry.html#rarentry.constants.attribute-unix-sym-link" class="link"><strong><code>RarEntry::ATTRIBUTE_UNIX_SYM_LINK</code></strong></a> and
<a href="class.rarentry.html#rarentry.constants.attribute-unix-socket" class="link"><strong><code>RarEntry::ATTRIBUTE_UNIX_SOCKET</code></strong></a>.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-fifo">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_FIFO</code></strong></span>
<dd>
<p class="para">Unix FIFOs will have attributes whose last four bits have this value. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX and with the
constant <a href="class.rarentry.html#rarentry.constants.attribute-unix-final-quartet" class="link">
<strong><code>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</code></strong></a>.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-char-dev">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_CHAR_DEV</code></strong></span>
<dd>
<p class="para">Unix character devices will have attributes whose last four bits have this value. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX and with the
constant <a href="class.rarentry.html#rarentry.constants.attribute-unix-final-quartet" class="link">
<strong><code>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</code></strong></a>.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-directory">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_DIRECTORY</code></strong></span>
<dd>
<p class="para">Unix directories will have attributes whose last four bits have this value. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX and with the
constant <a href="class.rarentry.html#rarentry.constants.attribute-unix-final-quartet" class="link">
<strong><code>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</code></strong></a>. See also
<span class="methodname"><a href="rarentry.isdirectory.html" class="methodname">RarEntry::isDirectory()</a></span>, which also works with entries that
were added in other operating systems.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-block-dev">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</code></strong></span>
<dd>
<p class="para">Unix block devices will have attributes whose last four bits have this value. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX and with the
constant <a href="class.rarentry.html#rarentry.constants.attribute-unix-final-quartet" class="link">
<strong><code>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</code></strong></a>.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-regular-file">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</code></strong></span>
<dd>
<p class="para">Unix regular files (not directories) will have attributes whose last four bits have this value. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX and with the
constant <a href="class.rarentry.html#rarentry.constants.attribute-unix-final-quartet" class="link">
<strong><code>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</code></strong></a>. See also
<span class="methodname"><a href="rarentry.isdirectory.html" class="methodname">RarEntry::isDirectory()</a></span>, which also works with entries that
were added in other operating systems.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-sym-link">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_SYM_LINK</code></strong></span>
<dd>
<p class="para">Unix symbolic links will have attributes whose last four bits have this value. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX and with the
constant <a href="class.rarentry.html#rarentry.constants.attribute-unix-final-quartet" class="link">
<strong><code>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</code></strong></a>.</p>
</dd>
</dt>
<dt id="rarentry.constants.attribute-unix-socket">
<span class="term"><strong><code>RarEntry::ATTRIBUTE_UNIX_SOCKET</code></strong></span>
<dd>
<p class="para">Unix sockets will have attributes whose last four bits have this value. To be used with
<span class="methodname"><a href="rarentry.getattr.html" class="methodname">RarEntry::getAttr()</a></span> on entries whose host OS is UNIX and with the
constant <a href="class.rarentry.html#rarentry.constants.attribute-unix-final-quartet" class="link">
<strong><code>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</code></strong></a>.</p>
</dd>
</dt>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="rarentry.extract.html">RarEntry::extract</a> — Extract entry from the archive</li><li><a href="rarentry.getattr.html">RarEntry::getAttr</a> — Get attributes of the entry</li><li><a href="rarentry.getcrc.html">RarEntry::getCrc</a> — Get CRC of the entry</li><li><a href="rarentry.getfiletime.html">RarEntry::getFileTime</a> — Get entry last modification time</li><li><a href="rarentry.gethostos.html">RarEntry::getHostOs</a> — Get entry host OS</li><li><a href="rarentry.getmethod.html">RarEntry::getMethod</a> — Get pack method of the entry</li><li><a href="rarentry.getname.html">RarEntry::getName</a> — Get name of the entry</li><li><a href="rarentry.getpackedsize.html">RarEntry::getPackedSize</a> — Get packed size of the entry</li><li><a href="rarentry.getstream.html">RarEntry::getStream</a> — Get file handler for entry</li><li><a href="rarentry.getunpackedsize.html">RarEntry::getUnpackedSize</a> — Get unpacked size of the entry</li><li><a href="rarentry.getversion.html">RarEntry::getVersion</a> — Get minimum version of RAR program required to unpack the entry</li><li><a href="rarentry.isdirectory.html">RarEntry::isDirectory</a> — Test whether an entry represents a directory</li><li><a href="rarentry.isencrypted.html">RarEntry::isEncrypted</a> — Test whether an entry is encrypted</li><li><a href="rarentry.tostring.html">RarEntry::__toString</a> — Get text representation of entry</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rararchive.tostring.html">RarArchive::__toString</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rarentry.extract.html">RarEntry::extract</a></div>
<div class="up"><a href="book.rar.html">Rar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
