## Apache Zeta Components Manual :: Package Archive Element Index

## Element index for package Archive

#### Package indexes

- Document
- NoPackageName
- SystemInformation
- File
- UserInput
- PersistentObjectDatabaseSchemaTiein
- ConsoleTools
- Cache
- Database
- UnitTest
- Feed
- Base
- AuthenticationDatabaseTiein
- TemplateTranslationTiein
- MvcMailTiein
- MvcTools
- MvcTemplateTiein
- Reflection
- Authentication
- Execution
- TranslationCacheTiein
- Url
- PhpGenerator
- WorkflowDatabaseTiein
- SignalSlot
- DatabaseSchema
- TreePersistentObjectTiein
- EventLog
- Tree
- Workflow
- ImageConversion
- PersistentObject
- Graph
- EventLogDatabaseTiein
- Translation
- WorkflowSignalSlotTiein
- Template
- Webdav
- Debug
- GraphDatabaseTiein
- MvcAuthenticationTiein
- MvcFeedTiein
- Mail
- TreeDatabaseTiein
- ImageAnalysis
- Search
- Configuration
- WorkflowEventLogTiein

[ a ] [ b ] [ c ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ l ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ z ] [ _ ]

### Letter '_'

__construct
  in file pax.php, method ezcArchivePaxTar::__construct()
  Initializes the Tar and tries to read the first entry from the archive.
__construct
  in file io.php, method ezcArchiveIoException::__construct()
  Constructs a new IO exception.
__construct
  in file internal_exception.php, method ezcArchiveInternalException::__construct()
  Construct an internal archive exception.
__construct
  in file unknown_type.php, method ezcArchiveUnknownTypeException::__construct()
  Constructs a new unknown type exception for the specified archive.
__construct
  in file ustar.php, method ezcArchiveUstarTar::__construct()
  Initializes the Tar and tries to read the first entry from the archive.
__construct
  in file zip.php, method ezcArchiveZip::__construct()
  Initializes the Zip archive and reads the entire archive.
__construct
  in file value.php, method ezcArchiveValueException::__construct()
  Construct an archive exception.
__construct
  in file v7.php, method ezcArchiveV7Tar::__construct()
  Initializes the Tar and tries to read the first entry from the archive.
__construct
  in file archive.php, method ezcArchiveOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file gnu.php, method ezcArchiveGnuTar::__construct()
  Initializes the Tar and tries to read the first entry from the archive.
__construct
  in file checksum.php, method ezcArchiveChecksumException::__construct()
  Constructs a new checksum exception for the specified file.
__construct
  in file block_size.php, method ezcArchiveBlockSizeException::__construct()
  Constructs a new block-size exception for the specified archive.
__construct
  in file exception.php, method ezcArchiveException::__construct()
  Construct a new archive exception.
__construct
  in file empty.php, method ezcArchiveEmptyException::__construct()
  Constructs a new exception for empty archive.
__construct
  in file entry_prefix.php, method ezcArchiveEntryPrefixException::__construct()
  Constructs a new entry prefix exception for the specified file entry.
__construct
  in file entry.php, method ezcArchiveEntry::__construct()
  Constructs an archiveEntry from the ezcArchiveFileStructure.
__destruct
  in file v7.php, method ezcArchiveV7Tar::__destruct()
  Closes the archive.
__toString
  in file archive.php, method ezcArchive::__toString()
  Returns a string which represents all the entries from the archive.
__toString
  in file entry.php, method ezcArchiveEntry::__toString()
  Returns a string representing the current entry.

### Letter 'a'

$addedBlocks
  in file v7.php, variable ezcArchiveV7Tar::$addedBlocks
  Stores the number of added blocks.
$addedBlocksNotReliable
  in file v7.php, variable ezcArchiveV7Tar::$addedBlocksNotReliable
  Specifies if unreliable blocks were added.
algorithmCanWrite
  in file archive.php, method ezcArchive::algorithmCanWrite()
  Returns true if writing to the archive is implemented, otherwise false.
algorithmCanWrite
  in file v7.php, method ezcArchiveV7Tar::algorithmCanWrite()
  Returns true because the TAR_V7 algorithm can write.
algorithmCanWrite
  in file pax.php, method ezcArchivePaxTar::algorithmCanWrite()
  Returns false because the TAR_PAX algorithm cannot write (yet).
algorithmCanWrite
  in file ustar.php, method ezcArchiveUstarTar::algorithmCanWrite()
  Returns true because the TAR_USTAR algorithm can write.
algorithmCanWrite
  in file gnu.php, method ezcArchiveGnuTar::algorithmCanWrite()
  Returns false because the TAR_PAX algorithm cannot write (yet).
algorithmCanWrite
  in file zip.php, method ezcArchiveZip::algorithmCanWrite()
  Returns true because the ZIP algorithm can write.
append
  in file v7.php, method ezcArchiveV7Tar::append()
  Append a file or directory to the end of the archive. Multiple files or directory can be added to the archive when an array is used as input parameter.
append
  in file zip.php, method ezcArchiveZip::append()
  Appends a file or directory to the end of the archive. Multiple files or directory can be added to the archive when an array is used as input parameter.
append
  in file archive.php, method ezcArchive::append()
  Appends a file or directory to the end of the archive. Multiple files or directory can be added to the archive when an array is used as input parameter.
appendHeaderAndFileToCurrent
  in file v7.php, method ezcArchiveV7Tar::appendHeaderAndFileToCurrent()
  Appends the given ezcArchiveBlockFile $file and ezcArchiveEntry $entry to the archive file.
appendNullBlocks
  in file v7.php, method ezcArchiveV7Tar::appendNullBlocks()
  Appends zero or more null blocks to the end of the archive, so that it matches the $blockFactor.
appendToCurrent
  in file v7.php, method ezcArchiveV7Tar::appendToCurrent()
  Appends a file to the archive after the current entry.
appendToCurrent
  in file zip.php, method ezcArchiveZip::appendToCurrent()
  Appends a file to the archive after the current entry.
appendToCurrent
  in file archive.php, method ezcArchive::appendToCurrent()
  Appends a file to the archive after the current entry.
archive.php
  procedural page archive.php
archive.php
  procedural page archive.php

### Letter 'b'

$blockFactor
  in file v7.php, variable ezcArchiveV7Tar::$blockFactor
  Tar archives have always $blockFactor of blocks.
block_size.php
  procedural page block_size.php
BLOCK_SIZE
  in file v7.php, class constant ezcArchiveV7Tar::BLOCK_SIZE
  Amount of bytes in a block.
BZIP2
  in file archive.php, class constant ezcArchive::BZIP2
  BZIP2 compression format.

### Letter 'c'

$centralHeaderPositions
  in file zip.php, variable ezcArchiveZip::$centralHeaderPositions
  Stores the byte number where the central directory header starts (fileNumber is the index of the array).
$centralHeaders
  in file zip.php, variable ezcArchiveZip::$centralHeaders
  Stores the ezcArchiveCentralDirectoryHeader for each entry.
$completed
  in file archive.php, variable ezcArchive::$completed
  Is true when the archive is read until the end, otherwise false.
checksum.php
  procedural page checksum.php
callback.php
  procedural page callback.php
close
  in file v7.php, method ezcArchiveV7Tar::close()
  Closes the archive correctly.
close
  in file archive.php, method ezcArchive::close()
  Close the current archive.
createDefaultDirectory
  in file archive.php, method ezcArchive::createDefaultDirectory()
  Creates all the directories needed to create the file $file.
createDirectoryCallback
  in file callback.php, method ezcArchiveCallback::createDirectoryCallback()
  Callback that's called for every directory creation.
createFileCallback
  in file callback.php, method ezcArchiveCallback::createFileCallback()
  Callback that's called for every file creation.
createInstance
  in file archive.php, method ezcArchive::createInstance()
  Returns an instance of the archive with the given type.
createTarHeader
  in file v7.php, method ezcArchiveV7Tar::createTarHeader()
  Creates the a new tar header for this class.
createTarHeader
  in file gnu.php, method ezcArchiveGnuTar::createTarHeader()
  Creates the a new pax tar header for this class.
createTarHeader
  in file pax.php, method ezcArchivePaxTar::createTarHeader()
  Creates the a new pax tar header for this class.
createTarHeader
  in file ustar.php, method ezcArchiveUstarTar::createTarHeader()
  Creates the a new ustar tar header for this class.
current
  in file archive.php, method ezcArchive::current()
  Returns the current ezcArchiveEntry if it is valid, otherwise false is returned.

### Letter 'e'

$endRecord
  in file zip.php, variable ezcArchiveZip::$endRecord
  Stores the ezcArchiveCentralDirectoryEndHeader.
$entries
  in file archive.php, variable ezcArchive::$entries
  Stores the entries read from the archive.
$entriesRead
  in file archive.php, variable ezcArchive::$entriesRead
  The number of entries currently read from the archive.
entry.php
  procedural page entry.php
empty.php
  procedural page empty.php
entry_prefix.php
  procedural page entry_prefix.php
exception.php
  procedural page exception.php
extract
  in file archive.php, method ezcArchive::extract()
  Extract entries from the archive to the target directory.
extractCurrent
  in file archive.php, method ezcArchive::extractCurrent()
  Extract the current entry to which the iterator points.
ezcArchive
  in file archive.php, class ezcArchive
  The ezcArchive class provides the common interface for reading and writing the archive formats Tar and Zip.
ezcArchiveBlockSizeException
  in file block_size.php, class ezcArchiveBlockSizeException
  Exception will be thrown when the block-size of an archive is invalid.
ezcArchiveCallback
  in file callback.php, class ezcArchiveCallback
  Class containing a basic implementation of the callback class to be called through extract.
ezcArchiveChecksumException
  in file checksum.php, class ezcArchiveChecksumException
  Exception will be thrown when the checksum of the file is invalid.
ezcArchiveEmptyException
  in file empty.php, class ezcArchiveEmptyException
  Exception for when an archive is empty.
ezcArchiveEntry
  in file entry.php, class ezcArchiveEntry
  The ezcArchiveEntry class provides system-independent file information.
ezcArchiveEntryPrefixException
  in file entry_prefix.php, class ezcArchiveEntryPrefixException
  An exception for an invalid prefix of a file entry.
ezcArchiveException
  in file exception.php, class ezcArchiveException
  General exception class for the Archive package.
ezcArchiveGnuTar
  in file gnu.php, class ezcArchiveGnuTar
  The ezcArchiveGnuTar class implements the GNU Tar archive format.
ezcArchiveInternalException
  in file internal_exception.php, class ezcArchiveInternalException
  Exception used when an internal errors occurs in the Archive component.
ezcArchiveIoException
  in file io.php, class ezcArchiveIoException
  Exception thrown when an IO error occurs.
ezcArchiveOptions
  in file archive.php, class ezcArchiveOptions
  Class containing the basic options for ezcBase' autoload.
ezcArchivePaxTar
  in file pax.php, class ezcArchivePaxTar
  The ezcArchivePaxTar class implements the Tar pax or posix archive format.
ezcArchiveUnknownTypeException
  in file unknown_type.php, class ezcArchiveUnknownTypeException
  Exception thrown when encountering an archive of an unknow type.
ezcArchiveUstarTar
  in file ustar.php, class ezcArchiveUstarTar
  The ezcArchiveUstarTar class implements the Tar ustar archive format.
ezcArchiveV7Tar
  in file v7.php, class ezcArchiveV7Tar
  The ezcArchiveV7Tar class implements the Tar v7 archive format.
ezcArchiveValueException
  in file value.php, class ezcArchiveValueException
  Exception thrown when encountering a wrong archive value.
ezcArchiveZip
  in file zip.php, class ezcArchiveZip
  The ezcArchiveZip class implements the Zip archive format.

### Letter 'f'

$file
  in file archive.php, variable ezcArchive::$file
  Direct access to the archive file.
$fileNumber
  in file archive.php, variable ezcArchive::$fileNumber
  The entry or file number to which the iterator points.
$fileStructure
  in file entry.php, variable ezcArchiveEntry::$fileStructure
  Contains the file information.

### Letter 'g'

gnu.php
  procedural page gnu.php
getAccessTime
  in file entry.php, method ezcArchiveEntry::getAccessTime()
  Returns the last access time as a timestamp.
getAlgorithm
  in file archive.php, method ezcArchive::getAlgorithm()
  Returns the algorithm that is used currently.
getAlgorithm
  in file gnu.php, method ezcArchiveGnuTar::getAlgorithm()
  Returns the value which specifies a TAR_GNU algorithm.
getAlgorithm
  in file zip.php, method ezcArchiveZip::getAlgorithm()
  Returns the value which specifies a ZIP algorithm.
getAlgorithm
  in file v7.php, method ezcArchiveV7Tar::getAlgorithm()
  Returns the value which specifies a TAR_V7 algorithm.
getAlgorithm
  in file pax.php, method ezcArchivePaxTar::getAlgorithm()
  Returns the value which specifies a TAR_PAX algorithm.
getAlgorithm
  in file ustar.php, method ezcArchiveUstarTar::getAlgorithm()
  Returns the value which specifies a TAR_USTAR algorithm.
getDevice
  in file entry.php, method ezcArchiveEntry::getDevice()
  Returns the device.
getEntries
  in file archive.php, method ezcArchive::getEntries()
  Get the file entries from the archive.
getEntryFromFile
  in file entry.php, method ezcArchiveEntry::getEntryFromFile()
  Returns one or an array of ezcArchiveEntry's from one or multiple files in the file system.
getFileData
  in file zip.php, method ezcArchiveZip::getFileData()
  Returns the file data of the given fileNumber.
getFileStructureFromFile
  in file entry.php, method ezcArchiveEntry::getFileStructureFromFile()
  Create a file structure from a $file in the file system.
getGroupId
  in file entry.php, method ezcArchiveEntry::getGroupId()
  Returns the group ID of the entry.
getInode
  in file entry.php, method ezcArchiveEntry::getInode()
  Returns the inode.
getLink
  in file entry.php, method ezcArchiveEntry::getLink()
  Returns the link with or without prefix.
getLinkType
  in file entry.php, method ezcArchiveEntry::getLinkType()
  Returns an ezcArchiveEntry-type that corresponds to the ezcArchiveStatMode-type
getListing
  in file archive.php, method ezcArchive::getListing()
  Returns an array that lists the content of the archive.
getLocalHeader
  in file zip.php, method ezcArchiveZip::getLocalHeader()
  Returns the local header of the specified file number.
getMajor
  in file entry.php, method ezcArchiveEntry::getMajor()
  Returns the major device number.
getMinor
  in file entry.php, method ezcArchiveEntry::getMinor()
  Returns the minor device number.
getModificationTime
  in file entry.php, method ezcArchiveEntry::getModificationTime()
  Returns the modification time as a timestamp.
getPath
  in file entry.php, method ezcArchiveEntry::getPath()
  Returns the complete path or path without the prefix.
getPermissions
  in file entry.php, method ezcArchiveEntry::getPermissions()
  Returns a bit mask representing the permissions of this entry.
getPermissionsString
  in file entry.php, method ezcArchiveEntry::getPermissionsString()
  Returns the permissions as a string.
getPrefix
  in file entry.php, method ezcArchiveEntry::getPrefix()
  Returns the prefix.
getSize
  in file entry.php, method ezcArchiveEntry::getSize()
  Returns the file size.
getTarInstance
  in file archive.php, method ezcArchive::getTarInstance()
  Open a tar instance.
getType
  in file entry.php, method ezcArchiveEntry::getType()
  Returns type of the entry.
getTypeString
  in file entry.php, method ezcArchiveEntry::getTypeString()
  Returns the type string for the current type of the entry.
getUserId
  in file entry.php, method ezcArchiveEntry::getUserId()
  Returns the user ID of the entry.
getZipInstance
  in file archive.php, method ezcArchive::getZipInstance()
  Open a zip instance. This method is made public for testing purposes, and should not be used.
GZIP
  in file archive.php, class constant ezcArchive::GZIP
  Gnu ZIP compression format.

### Letter 'h'

$hasNullBlocks
  in file v7.php, variable ezcArchiveV7Tar::$hasNullBlocks
  Specifies if the archive contains null blocks.
$headerPositions
  in file v7.php, variable ezcArchiveV7Tar::$headerPositions
  Stores the block number where the header starts.
$headers
  in file v7.php, variable ezcArchiveV7Tar::$headers
  Stores all the headers from the archive.

### Letter 'i'

internal_exception.php
  procedural page internal_exception.php
io.php
  procedural page io.php
isDirectory
  in file entry.php, method ezcArchiveEntry::isDirectory()
  Returns true when this entry represents a directory.
isEmpty
  in file archive.php, method ezcArchive::isEmpty()
  Returns true if the current archive is empty, otherwise false.
isFile
  in file entry.php, method ezcArchiveEntry::isFile()
  Returns true when this entry represents a file.
isHardLink
  in file entry.php, method ezcArchiveEntry::isHardLink()
  Returns true when this entry represents a hard link.
isLink
  in file entry.php, method ezcArchiveEntry::isLink()
  Returns true when this entry represents a symbolic or a hard link.
isSymLink
  in file entry.php, method ezcArchiveEntry::isSymLink()
  Returns true when this entry represents a symbolic link.
isWritable
  in file zip.php, method ezcArchiveZip::isWritable()
  Returns true if it is possible to write to the archive, otherwise false.
IS_BLOCK_DEVICE
  in file entry.php, class constant ezcArchiveEntry::IS_BLOCK_DEVICE
  Is a block device.
IS_CHARACTER_DEVICE
  in file entry.php, class constant ezcArchiveEntry::IS_CHARACTER_DEVICE
  Is a character device.
IS_DIRECTORY
  in file entry.php, class constant ezcArchiveEntry::IS_DIRECTORY
  Is a directory.
IS_FIFO
  in file entry.php, class constant ezcArchiveEntry::IS_FIFO
  Is a FIFO.
IS_FILE
  in file entry.php, class constant ezcArchiveEntry::IS_FILE
  Is a regular file.
IS_LINK
  in file entry.php, class constant ezcArchiveEntry::IS_LINK
  Is a hard link.
IS_RESERVED
  in file entry.php, class constant ezcArchiveEntry::IS_RESERVED
  Not used, is Tar specific?
IS_SYMBOLIC_LINK
  in file entry.php, class constant ezcArchiveEntry::IS_SYMBOLIC_LINK
  Is a symbolic link.

### Letter 'k'

key
  in file archive.php, method ezcArchive::key()
  Returns the current key, entry number, if it is valid, otherwise false is returned.

### Letter 'l'

$localHeaderPositions
  in file zip.php, variable ezcArchiveZip::$localHeaderPositions
  Stores the byte number where the local file header starts for each entry.
$localHeaders
  in file zip.php, variable ezcArchiveZip::$localHeaders
  Stores the ezcArchiveLocalFileHeader for each entry.

### Letter 'n'

next
  in file archive.php, method ezcArchive::next()
  Forwards the iterator to the next entry.

### Letter 'o'

$options
  in file archive.php, variable ezcArchive::$options
  Holds the options if passed to the open method.
open
  in file archive.php, method ezcArchive::open()
  Returns a new ezcArchive instance.

### Letter 'p'

$prefix
  in file entry.php, variable ezcArchiveEntry::$prefix
  The prefix of the file that may be removed from the path.
pax.php
  procedural page pax.php

### Letter 'r'

readCentralHeaders
  in file zip.php, method ezcArchiveZip::readCentralHeaders()
  Reads the entire archive and creates all the entries.
readCurrentFromArchive
  in file v7.php, method ezcArchiveV7Tar::readCurrentFromArchive()
  Read the current entry from the archive.
removePrefixFromPath
  in file entry.php, method ezcArchiveEntry::removePrefixFromPath()
  Removes the prefix from the path and clears the prefix.
rewind
  in file archive.php, method ezcArchive::rewind()
  Rewinds the iterator to the first entry.

### Letter 's'

seek
  in file archive.php, method ezcArchive::seek()
  Search for the entry number.
setEndRecord
  in file zip.php, method ezcArchiveZip::setEndRecord()
  Creates and sets a new ezcArchiveCentralDirectoryEndHeader.
setOptions
  in file archive.php, method ezcArchive::setOptions()
  This method associates a new $options object with this archive.
setPrefix
  in file entry.php, method ezcArchiveEntry::setPrefix()
  Sets the prefix.

### Letter 't'

TAR
  in file archive.php, class constant ezcArchive::TAR
  Normal tar archive.
TAR_GNU
  in file archive.php, class constant ezcArchive::TAR_GNU
  GNU tar archive.
TAR_PAX
  in file archive.php, class constant ezcArchive::TAR_PAX
  PAX tar archive.
TAR_USTAR
  in file archive.php, class constant ezcArchive::TAR_USTAR
  USTAR tar archive.
TAR_V7
  in file archive.php, class constant ezcArchive::TAR_V7
  Tar version 7 archive.
truncate
  in file zip.php, method ezcArchiveZip::truncate()
  Truncates the archive to $fileNumber of files.
truncate
  in file archive.php, method ezcArchive::truncate()
  Truncates the archive to $fileNumber of files.
truncate
  in file v7.php, method ezcArchiveV7Tar::truncate()
  Truncates the archive to $fileNumber of files.

### Letter 'u'

unknown_type.php
  procedural page unknown_type.php
ustar.php
  procedural page ustar.php

### Letter 'v'

value.php
  procedural page value.php
v7.php
  procedural page v7.php
valid
  in file archive.php, method ezcArchive::valid()
  Returns true if the iterator points to a valid entry, otherwise false.

### Letter 'w'

writeCurrentDataToFile
  in file archive.php, method ezcArchive::writeCurrentDataToFile()
  Writes the file data from the current entry to the given file.
writeCurrentDataToFile
  in file v7.php, method ezcArchiveV7Tar::writeCurrentDataToFile()
  Writes the file data from the current entry to the given file.
writeCurrentDataToFile
  in file zip.php, method ezcArchiveZip::writeCurrentDataToFile()
  Writes the file data from the current entry to the given file.
writeEnd
  in file v7.php, method ezcArchiveV7Tar::writeEnd()
  Writes the end of the archive.
writeFile
  in file zip.php, method ezcArchiveZip::writeFile()
  Reads the file data from the archive and writes it the the $writeTo file.

### Letter 'z'

zip.php
  procedural page zip.php
ZIP
  in file archive.php, class constant ezcArchive::ZIP
  ZIP archive.

Documentation generated by phpDocumentor 1.4.3