RARENTRY(3)								 1							       RARENTRY(3)

The RarEntry class

INTRODUCTION

	A RAR entry, representing a directory or a compressed file inside a RAR archive.

CLASS SYNOPSIS

       RarEntry

       final
       RarEntry

       Constants

       o const integer$RarEntry::HOST_MSDOS0

       o const integer$RarEntry::HOST_OS21

       o const integer$RarEntry::HOST_WIN322

       o const integer$RarEntry::HOST_UNIX3

       o const integer$RarEntry::HOST_MACOS4

       o const integer$RarEntry::HOST_BEOS5

       o const integer$RarEntry::ATTRIBUTE_WIN_READONLY1

       o const integer$RarEntry::ATTRIBUTE_WIN_HIDDEN2

       o const integer$RarEntry::ATTRIBUTE_WIN_SYSTEM4

       o const integer$RarEntry::ATTRIBUTE_WIN_DIRECTORY16

       o const integer$RarEntry::ATTRIBUTE_WIN_ARCHIVE32

       o const integer$RarEntry::ATTRIBUTE_WIN_DEVICE64

       o const integer$RarEntry::ATTRIBUTE_WIN_NORMAL128

       o const integer$RarEntry::ATTRIBUTE_WIN_TEMPORARY256

       o const integer$RarEntry::ATTRIBUTE_WIN_SPARSE_FILE512

       o const integer$RarEntry::ATTRIBUTE_WIN_REPARSE_POINT1024

       o const integer$RarEntry::ATTRIBUTE_WIN_COMPRESSED2048

       o const integer$RarEntry::ATTRIBUTE_WIN_OFFLINE4096

       o const integer$RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED8192

       o const integer$RarEntry::ATTRIBUTE_WIN_ENCRYPTED16384

       o const integer$RarEntry::ATTRIBUTE_WIN_VIRTUAL65536

       o const integer$RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE1

       o const integer$RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE2

       o const integer$RarEntry::ATTRIBUTE_UNIX_WORLD_READ4

       o const integer$RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE8

       o const integer$RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE16

       o const integer$RarEntry::ATTRIBUTE_UNIX_GROUP_READ32

       o const integer$RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE64

       o const integer$RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE128

       o const integer$RarEntry::ATTRIBUTE_UNIX_OWNER_READ256

       o const integer$RarEntry::ATTRIBUTE_UNIX_STICKY512

       o const integer$RarEntry::ATTRIBUTE_UNIX_SETGID1024

       o const integer$RarEntry::ATTRIBUTE_UNIX_SETUID2048

       o const integer$RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET61440

       o const integer$RarEntry::ATTRIBUTE_UNIX_FIFO4096

       o const integer$RarEntry::ATTRIBUTE_UNIX_CHAR_DEV8192

       o const integer$RarEntry::ATTRIBUTE_UNIX_DIRECTORY16384

       o const integer$RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV24576

       o const integer$RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE32768

       o const integer$RarEntry::ATTRIBUTE_UNIX_SYM_LINK40960

       o const integer$RarEntry::ATTRIBUTE_UNIX_SOCKET49152

       Methods

       o public bool RarEntry::extract (string	$dir, [string  $filepath = ""], [string  $password = NULL], [bool  $extended_data = false])

       o public int RarEntry::getAttr (void  )

       o public string RarEntry::getCrc (void  )

       o public string RarEntry::getFileTime (void  )

       o public int RarEntry::getHostOs (void  )

       o public int RarEntry::getMethod (void  )

       o public string RarEntry::getName (void	)

       o public int RarEntry::getPackedSize (void  )

       o public resource RarEntry::getStream ([string  $password])

       o public int RarEntry::getUnpackedSize (void  )

       o public int RarEntry::getVersion (void	)

       o public bool RarEntry::isDirectory (void  )

       o public bool RarEntry::isEncrypted (void  )

       o public string RarEntry::__toString (void  )

PREDEFINED CONSTANTS

	      o RarEntry::HOST_MSDOS  -If  the	return	value  of RarEntry::getHostOs equals this constant, MS-DOS was used to add this entry. Use
		instead of RAR_HOST_MSDOS.

	      o RarEntry::HOST_OS2 -If the return value of RarEntry::getHostOs equals this constant, OS/2 was used to add this entry. Intended	to
		replace RAR_HOST_OS2.

	      o RarEntry::HOST_WIN32  -If  the	return	value  of RarEntry::getHostOs equals this constant, Microsoft Windows was used to add this
		entry. Intended to replace RAR_HOST_WIN32.

	      o RarEntry::HOST_UNIX -If the return value of RarEntry::getHostOs equals this constant, an unspecified UNIX OS was used to add  this
		entry. Intended to replace RAR_HOST_UNIX.

	      o RarEntry::HOST_MACOS -If the return value of RarEntry::getHostOs equals this constant, Mac OS was used to add this entry.

	      o RarEntry::HOST_BEOS -If the return value of RarEntry::getHostOs equals this constant, BeOS was used to add this entry. Intended to
		replace RAR_HOST_BEOS.

	      o RarEntry::ATTRIBUTE_WIN_READONLY -Bit that represents a Windows  entry	with  a  read-only  attribute.	To  be	used  with  RarEn-
		try::getAttr on entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_HIDDEN	-Bit that represents a Windows entry with a hidden attribute. To be used with RarEntry::getAttr on
		entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_SYSTEM -Bit that represents a Windows entry with a system attribute. To be used with RarEntry::getAttr	on
		entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_DIRECTORY  -Bit  that  represents a Windows entry with a directory attribute (entry is a directory). To be
		used with RarEntry::getAttr on entries whose host OS is Microsoft Windows. See also RarEntry::isDirectory, which also  works  with
		entries that were not added in WinRAR.

	      o RarEntry::ATTRIBUTE_WIN_ARCHIVE  -Bit that represents a Windows entry with an archive attribute. To be used with RarEntry::getAttr
		on entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_DEVICE -Bit that represents a Windows entry with a device attribute. To be used with RarEntry::getAttr	on
		entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_NORMAL -Bit that represents a Windows entry with a normal file attribute (entry is NOT a directory). To be
		used with RarEntry::getAttr on entries whose host OS is Microsoft Windows. See also RarEntry::isDirectory, which also  works  with
		entries that were not added in WinRAR.

	      o RarEntry::ATTRIBUTE_WIN_TEMPORARY  -Bit  that  represents  a  Windows  entry  with  a  temporary attribute. To be used with RarEn-
		try::getAttr on entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_SPARSE_FILE -Bit that represents a Windows entry with a sparse file attribute  (file  is  an  NTFS  sparse
		file). To be used with RarEntry::getAttr on entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_REPARSE_POINT  -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 RarEntry::getAttr on entries whose  host  OS	is
		Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_COMPRESSED  -Bit  that represents a Windows entry with a compressed attribute (NTFS only). To be used with
		RarEntry::getAttr on entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_OFFLINE -Bit that represents a Windows entry with an offline attribute (entry is offline and not  accessi-
		ble). To be used with RarEntry::getAttr on entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED -Bit that represents a Windows entry with a not content indexed attribute (entry is to
		be indexed). To be used with RarEntry::getAttr on entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_ENCRYPTED -Bit that represents a Windows entry with an encrypted attribute (NTFS only). To  be	used  with
		RarEntry::getAttr on entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_WIN_VIRTUAL  -Bit  that represents a Windows entry with a virtual attribute. To be used with RarEntry::getAttr
		on entries whose host OS is Microsoft Windows.

	      o RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE -Bit that represents a UNIX entry  that	is  world  executable.	To  be	used  with  RarEn-
		try::getAttr on entries whose host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE  -Bit  that represents a UNIX entry that is world writable. To be used with RarEntry::getAttr
		on entries whose host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_WORLD_READ -Bit that represents a UNIX entry that is world readable. To be used with RarEntry::getAttr on
		entries whose host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE	-Bit  that  represents	a  UNIX  entry	that  is  group executable. To be used with RarEn-
		try::getAttr on entries whose host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE -Bit that represents a UNIX entry that is group writable. To be used  with  RarEntry::getAttr
		on entries whose host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_GROUP_READ -Bit that represents a UNIX entry that is group readable. To be used with RarEntry::getAttr on
		entries whose host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE -Bit that represents a UNIX entry  that	is  owner  executable.	To  be	used  with  RarEn-
		try::getAttr on entries whose host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE  -Bit  that represents a UNIX entry that is owner writable. To be used with RarEntry::getAttr
		on entries whose host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_OWNER_READ -Bit that represents a UNIX entry that is owner readable. To be used with RarEntry::getAttr on
		entries whose host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_STICKY  -Bit that represents the UNIX sticky bit. To be used with RarEntry::getAttr on entries whose host
		OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_SETGID -Bit that represents the UNIX setgid attribute. To be used with RarEntry::getAttr on entries whose
		host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_SETUID -Bit that represents the UNIX setuid attribute. To be used with RarEntry::getAttr on entries whose
		host OS is UNIX.

	      o RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET -Mask to isolate the last four bits (nibble) of UNIX attributes (_S_IFMT, the type of  file
		mask).	To  be	used with RarEntry::getAttr on entries whose host OS is UNIX and with the constants RarEntry::ATTRIBUTE_UNIX_FIFO,
		RarEntry::ATTRIBUTE_UNIX_CHAR_DEV,	RarEntry::ATTRIBUTE_UNIX_DIRECTORY,	  RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV,	    RarEn-
		try::ATTRIBUTE_UNIX_REGULAR_FILE, RarEntry::ATTRIBUTE_UNIX_SYM_LINK and RarEntry::ATTRIBUTE_UNIX_SOCKET.

	      o RarEntry::ATTRIBUTE_UNIX_FIFO  -Unix  FIFOs  will  have  attributes  whose  last four bits have this value. To be used with RarEn-
		try::getAttr on entries whose host OS is UNIX and with the constant RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET.

	      o RarEntry::ATTRIBUTE_UNIX_CHAR_DEV -Unix character devices will have attributes whose last four bits have this value.  To  be  used
		with RarEntry::getAttr on entries whose host OS is UNIX and with the constant RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET.

	      o RarEntry::ATTRIBUTE_UNIX_DIRECTORY  -Unix  directories	will have attributes whose last four bits have this value. To be used with
		RarEntry::getAttr on entries whose host OS is UNIX and with the constant RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. See  also  RarEn-
		try::isDirectory, which also works with entries that were added in other operating systems.

	      o RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV  -Unix block devices will have attributes whose last four bits have this value. To be used with
		RarEntry::getAttr on entries whose host OS is UNIX and with the constant RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET.

	      o RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE -Unix regular files (not directories) will have attributes whose last four  bits	have  this
		value.	 To   be   used   with	 RarEntry::getAttr   on   entries   whose   host   OS	is  UNIX  and  with  the  constant  RarEn-
		try::ATTRIBUTE_UNIX_FINAL_QUARTET. See also RarEntry::isDirectory, which also works with entries that were added in other  operat-
		ing systems.

	      o RarEntry::ATTRIBUTE_UNIX_SYM_LINK  -Unix symbolic links will have attributes whose last four bits have this value. To be used with
		RarEntry::getAttr on entries whose host OS is UNIX and with the constant RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET.

	      o RarEntry::ATTRIBUTE_UNIX_SOCKET -Unix sockets will have attributes whose last four bits have this value. To be	used  with  RarEn-
		try::getAttr on entries whose host OS is UNIX and with the constant RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET.

PHP Documentation Group 													       RARENTRY(3)