rarentry.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.rarentry" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The <classname>RarEntry</classname> class</title>
 <titleabbrev>RarEntry</titleabbrev>

 <partintro>

<!-- {{{ RarEntry intro -->
  <section xml:id="rarentry.intro">
   &reftitle.intro;
   <para>
    A RAR entry, representing a directory or a compressed file inside a RAR archive.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="rarentry.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>RarEntry</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <modifier>final</modifier>
      <classname>RarEntry</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.host-msdos">RarEntry::HOST_MSDOS</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.host-os2">RarEntry::HOST_OS2</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.host-win32">RarEntry::HOST_WIN32</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.host-unix">RarEntry::HOST_UNIX</varname>
     <initializer>3</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.host-macos">RarEntry::HOST_MACOS</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.host-beos">RarEntry::HOST_BEOS</varname>
     <initializer>5</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-readonly">RarEntry::ATTRIBUTE_WIN_READONLY</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-hidden">RarEntry::ATTRIBUTE_WIN_HIDDEN</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-system">RarEntry::ATTRIBUTE_WIN_SYSTEM</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-directory">RarEntry::ATTRIBUTE_WIN_DIRECTORY</varname>
     <initializer>16</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-archive">RarEntry::ATTRIBUTE_WIN_ARCHIVE</varname>
     <initializer>32</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-device">RarEntry::ATTRIBUTE_WIN_DEVICE</varname>
     <initializer>64</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-normal">RarEntry::ATTRIBUTE_WIN_NORMAL</varname>
     <initializer>128</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-temporary">RarEntry::ATTRIBUTE_WIN_TEMPORARY</varname>
     <initializer>256</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-sparse-file">RarEntry::ATTRIBUTE_WIN_SPARSE_FILE</varname>
     <initializer>512</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-reparse-point">RarEntry::ATTRIBUTE_WIN_REPARSE_POINT</varname>
     <initializer>1024</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-compressed">RarEntry::ATTRIBUTE_WIN_COMPRESSED</varname>
     <initializer>2048</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-offline">RarEntry::ATTRIBUTE_WIN_OFFLINE</varname>
     <initializer>4096</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-not-content-indexed">RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED</varname>
     <initializer>8192</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-encrypted">RarEntry::ATTRIBUTE_WIN_ENCRYPTED</varname>
     <initializer>16384</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-win-virtual">RarEntry::ATTRIBUTE_WIN_VIRTUAL</varname>
     <initializer>65536</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-world-execute">RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-world-write">RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-world-read">RarEntry::ATTRIBUTE_UNIX_WORLD_READ</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-group-execute">RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE</varname>
     <initializer>8</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-group-write">RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE</varname>
     <initializer>16</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-group-read">RarEntry::ATTRIBUTE_UNIX_GROUP_READ</varname>
     <initializer>32</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-owner-execute">RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE</varname>
     <initializer>64</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-owner-write">RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE</varname>
     <initializer>128</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-owner-read">RarEntry::ATTRIBUTE_UNIX_OWNER_READ</varname>
     <initializer>256</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-sticky">RarEntry::ATTRIBUTE_UNIX_STICKY</varname>
     <initializer>512</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-setgid">RarEntry::ATTRIBUTE_UNIX_SETGID</varname>
     <initializer>1024</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-setuid">RarEntry::ATTRIBUTE_UNIX_SETUID</varname>
     <initializer>2048</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-final-quartet">RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</varname>
     <initializer>61440</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-fifo">RarEntry::ATTRIBUTE_UNIX_FIFO</varname>
     <initializer>4096</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-char-dev">RarEntry::ATTRIBUTE_UNIX_CHAR_DEV</varname>
     <initializer>8192</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-directory">RarEntry::ATTRIBUTE_UNIX_DIRECTORY</varname>
     <initializer>16384</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-block-dev">RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</varname>
     <initializer>24576</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-regular-file">RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</varname>
     <initializer>32768</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-sym-link">RarEntry::ATTRIBUTE_UNIX_SYM_LINK</varname>
     <initializer>40960</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="rarentry.constants.attribute-unix-socket">RarEntry::ATTRIBUTE_UNIX_SOCKET</varname>
     <initializer>49152</initializer>
    </fieldsynopsis>
    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rarentry')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ RarEntry constants -->
  <section xml:id="rarentry.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="rarentry.constants.host-msdos">
     <term><constant>RarEntry::HOST_MSDOS</constant></term>
     <listitem>
      <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, MS-DOS was used to
      add this entry. Use instead of <constant>RAR_HOST_MSDOS</constant>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.host-os2">
     <term><constant>RarEntry::HOST_OS2</constant></term>
     <listitem>
      <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, OS/2 was used to
      add this entry. Intended to replace <constant>RAR_HOST_OS2</constant>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.host-win32">
     <term><constant>RarEntry::HOST_WIN32</constant></term>
     <listitem>
      <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, Microsoft Windows was used to
      add this entry. Intended to replace <constant>RAR_HOST_WIN32</constant>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.host-unix">
     <term><constant>RarEntry::HOST_UNIX</constant></term>
     <listitem>
      <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, an unspecified UNIX OS was used to
      add this entry. Intended to replace <constant>RAR_HOST_UNIX</constant>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.host-macos">
     <term><constant>RarEntry::HOST_MACOS</constant></term>
     <listitem>
      <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, Mac OS was used to
      add this entry.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.host-beos">
     <term><constant>RarEntry::HOST_BEOS</constant></term>
     <listitem>
      <para>If the return value of <methodname>RarEntry::getHostOs</methodname> equals this constant, BeOS was used to
      add this entry. Intended to replace <constant>RAR_HOST_BEOS</constant>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-readonly">
     <term><constant>RarEntry::ATTRIBUTE_WIN_READONLY</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a read-only attribute. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-hidden">
     <term><constant>RarEntry::ATTRIBUTE_WIN_HIDDEN</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a hidden attribute. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-system">
     <term><constant>RarEntry::ATTRIBUTE_WIN_SYSTEM</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a system attribute. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-directory">
     <term><constant>RarEntry::ATTRIBUTE_WIN_DIRECTORY</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a directory attribute (entry is a directory). To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows. See also
      <methodname>RarEntry::isDirectory</methodname>, which also works with entries that were not added in WinRAR.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-archive">
     <term><constant>RarEntry::ATTRIBUTE_WIN_ARCHIVE</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with an archive attribute. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-device">
     <term><constant>RarEntry::ATTRIBUTE_WIN_DEVICE</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a device attribute. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-normal">
     <term><constant>RarEntry::ATTRIBUTE_WIN_NORMAL</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a normal file attribute (entry is NOT a directory). To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows. See also
      <methodname>RarEntry::isDirectory</methodname>, which also works with entries that were not added in WinRAR.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-temporary">
     <term><constant>RarEntry::ATTRIBUTE_WIN_TEMPORARY</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a temporary attribute. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-sparse-file">
     <term><constant>RarEntry::ATTRIBUTE_WIN_SPARSE_FILE</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a sparse file attribute (file is an NTFS sparse file). To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-reparse-point">
     <term><constant>RarEntry::ATTRIBUTE_WIN_REPARSE_POINT</constant></term>
     <listitem>
      <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
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-compressed">
     <term><constant>RarEntry::ATTRIBUTE_WIN_COMPRESSED</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a compressed attribute (NTFS only). To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-offline">
     <term><constant>RarEntry::ATTRIBUTE_WIN_OFFLINE</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with an offline attribute (entry is offline and not accessible). To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-not-content-indexed">
     <term><constant>RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a not content indexed attribute (entry is to be indexed). To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-encrypted">
     <term><constant>RarEntry::ATTRIBUTE_WIN_ENCRYPTED</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with an encrypted attribute (NTFS only). To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-win-virtual">
     <term><constant>RarEntry::ATTRIBUTE_WIN_VIRTUAL</constant></term>
     <listitem>
      <para>Bit that represents a Windows entry with a virtual attribute. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is Microsoft Windows.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-world-execute">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE</constant></term>
     <listitem>
      <para>Bit that represents a UNIX entry that is world executable. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-world-write">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE</constant></term>
     <listitem>
      <para>Bit that represents a UNIX entry that is world writable. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-world-read">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_WORLD_READ</constant></term>
     <listitem>
      <para>Bit that represents a UNIX entry that is world readable. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-group-execute">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE</constant></term>
     <listitem>
      <para>Bit that represents a UNIX entry that is group executable. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-group-write">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE</constant></term>
     <listitem>
      <para>Bit that represents a UNIX entry that is group writable. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-group-read">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_GROUP_READ</constant></term>
     <listitem>
      <para>Bit that represents a UNIX entry that is group readable. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-owner-execute">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE</constant></term>
     <listitem>
      <para>Bit that represents a UNIX entry that is owner executable. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-owner-write">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE</constant></term>
     <listitem>
      <para>Bit that represents a UNIX entry that is owner writable. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-owner-read">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_OWNER_READ</constant></term>
     <listitem>
      <para>Bit that represents a UNIX entry that is owner readable. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-sticky">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_STICKY</constant></term>
     <listitem>
      <para>Bit that represents the UNIX sticky bit. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-setgid">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_SETGID</constant></term>
     <listitem>
      <para>Bit that represents the UNIX setgid attribute. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-setuid">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_SETUID</constant></term>
     <listitem>
      <para>Bit that represents the UNIX setuid attribute. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-final-quartet">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></term>
     <listitem>
      <para>Mask to isolate the last four bits (nibble) of UNIX attributes
      (_S_IFMT, the type of file mask). To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
      constants <link linkend="rarentry.constants.attribute-unix-fifo"><constant>RarEntry::ATTRIBUTE_UNIX_FIFO</constant></link>,
      <link linkend="rarentry.constants.attribute-unix-char-dev"><constant>RarEntry::ATTRIBUTE_UNIX_CHAR_DEV</constant></link>,
      <link linkend="rarentry.constants.attribute-unix-directory"><constant>RarEntry::ATTRIBUTE_UNIX_DIRECTORY</constant></link>,
      <link linkend="rarentry.constants.attribute-unix-block-dev"><constant>RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</constant></link>,
      <link linkend="rarentry.constants.attribute-unix-regular-file"><constant>RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</constant></link>,
      <link linkend="rarentry.constants.attribute-unix-sym-link"><constant>RarEntry::ATTRIBUTE_UNIX_SYM_LINK</constant></link> and
      <link linkend="rarentry.constants.attribute-unix-socket"><constant>RarEntry::ATTRIBUTE_UNIX_SOCKET</constant></link>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-fifo">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_FIFO</constant></term>
     <listitem>
      <para>Unix FIFOs will have attributes whose last four bits have this value. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
      constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
      <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-char-dev">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_CHAR_DEV</constant></term>
     <listitem>
      <para>Unix character devices will have attributes whose last four bits have this value. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
      constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
      <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-directory">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_DIRECTORY</constant></term>
     <listitem>
      <para>Unix directories will have attributes whose last four bits have this value. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
      constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
      <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>. See also
      <methodname>RarEntry::isDirectory</methodname>, which also works with entries that
      were added in other operating systems.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-block-dev">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</constant></term>
     <listitem>
      <para>Unix block devices will have attributes whose last four bits have this value. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
      constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
      <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-regular-file">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</constant></term>
     <listitem>
      <para>Unix regular files (not directories) will have attributes whose last four bits have this value. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
      constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
      <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>. See also
      <methodname>RarEntry::isDirectory</methodname>, which also works with entries that
      were added in other operating systems.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-sym-link">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_SYM_LINK</constant></term>
     <listitem>
      <para>Unix symbolic links will have attributes whose last four bits have this value. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
      constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
      <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="rarentry.constants.attribute-unix-socket">
     <term><constant>RarEntry::ATTRIBUTE_UNIX_SOCKET</constant></term>
     <listitem>
      <para>Unix sockets will have attributes whose last four bits have this value. To be used with
      <methodname>RarEntry::getAttr</methodname> on entries whose host OS is UNIX and with the
      constant <link linkend="rarentry.constants.attribute-unix-final-quartet">
      <constant>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</constant></link>.</para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.rar.entities.rarentry;

</phpdoc:classref>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->