[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Element index for package Archive

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

_

__construct : ezcArchivePaxTar

in file pax.php, method ezcArchivePaxTar::__construct()
    Initializes the Tar and tries to read the first entry from the archive.

__construct : ezcArchiveIoException

in file io.php, method ezcArchiveIoException::__construct()
    Constructs a new IO exception.

__construct : ezcArchiveInternalException

in file internal_exception.php, method ezcArchiveInternalException::__construct()
    Construct an internal archive exception.

__construct : ezcArchiveUnknownTypeException

in file unknown_type.php, method ezcArchiveUnknownTypeException::__construct()
    Constructs a new unknown type exception for the specified archive.

__construct : ezcArchiveUstarTar

in file ustar.php, method ezcArchiveUstarTar::__construct()
    Initializes the Tar and tries to read the first entry from the archive.

__construct : ezcArchiveZip

in file zip.php, method ezcArchiveZip::__construct()
    Initializes the Zip archive and reads the entire archive.

__construct : ezcArchiveValueException

in file value.php, method ezcArchiveValueException::__construct()
    Construct an archive exception.

__construct : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::__construct()
    Initializes the Tar and tries to read the first entry from the archive.

__construct : ezcArchiveOptions

in file archive.php, method ezcArchiveOptions::__construct()
    Constructs an object with the specified values.

__construct : ezcArchiveGnuTar

in file gnu.php, method ezcArchiveGnuTar::__construct()
    Initializes the Tar and tries to read the first entry from the archive.

__construct : ezcArchiveChecksumException

in file checksum.php, method ezcArchiveChecksumException::__construct()
    Constructs a new checksum exception for the specified file.

__construct : ezcArchiveBlockSizeException

in file block_size.php, method ezcArchiveBlockSizeException::__construct()
    Constructs a new block-size exception for the specified archive.

__construct : ezcArchiveException

in file exception.php, method ezcArchiveException::__construct()
    Construct a new archive exception.

__construct : ezcArchiveEmptyException

in file empty.php, method ezcArchiveEmptyException::__construct()
    Constructs a new exception for empty archive.

__construct : ezcArchiveEntryPrefixException

in file entry_prefix.php, method ezcArchiveEntryPrefixException::__construct()
    Constructs a new entry prefix exception for the specified file entry.

__construct : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::__construct()
    Constructs an archiveEntry from the ezcArchiveFileStructure.

__destruct : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::__destruct()
    Closes the archive.

__toString : ezcArchive

in file archive.php, method ezcArchive::__toString()
    Returns a string which represents all the entries from the archive.

__toString : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::__toString()
    Returns a string representing the current entry.

a

$addedBlocks : ezcArchiveV7Tar

in file v7.php, variable ezcArchiveV7Tar::$addedBlocks
    Stores the number of added blocks.

$addedBlocksNotReliable : ezcArchiveV7Tar

in file v7.php, variable ezcArchiveV7Tar::$addedBlocksNotReliable
    Specifies if unreliable blocks were added.

algorithmCanWrite : ezcArchive

in file archive.php, method ezcArchive::algorithmCanWrite()
    Returns true if writing to the archive is implemented, otherwise false.

algorithmCanWrite : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::algorithmCanWrite()
    Returns true because the TAR_V7 algorithm can write.

algorithmCanWrite : ezcArchivePaxTar

in file pax.php, method ezcArchivePaxTar::algorithmCanWrite()
    Returns false because the TAR_PAX algorithm cannot write (yet).

algorithmCanWrite : ezcArchiveUstarTar

in file ustar.php, method ezcArchiveUstarTar::algorithmCanWrite()
    Returns true because the TAR_USTAR algorithm can write.

algorithmCanWrite : ezcArchiveGnuTar

in file gnu.php, method ezcArchiveGnuTar::algorithmCanWrite()
    Returns false because the TAR_PAX algorithm cannot write (yet).

algorithmCanWrite : ezcArchiveZip

in file zip.php, method ezcArchiveZip::algorithmCanWrite()
    Returns true because the ZIP algorithm can write.

append : ezcArchiveV7Tar

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 : ezcArchiveZip

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 : ezcArchive

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 : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::appendHeaderAndFileToCurrent()
    Appends the given ezcArchiveBlockFile $file and ezcArchiveEntry $entry to the archive file.

appendNullBlocks : ezcArchiveV7Tar

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 : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::appendToCurrent()
    Appends a file to the archive after the current entry.

appendToCurrent : ezcArchiveZip

in file zip.php, method ezcArchiveZip::appendToCurrent()
    Appends a file to the archive after the current entry.

appendToCurrent : ezcArchive

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

b

$blockFactor : ezcArchiveV7Tar

in file v7.php, variable ezcArchiveV7Tar::$blockFactor
    Tar archives have always $blockFactor of blocks.

block_size.php

procedural page block_size.php

BLOCK_SIZE : ezcArchiveV7Tar

in file v7.php, class constant ezcArchiveV7Tar::BLOCK_SIZE
    Amount of bytes in a block.

BZIP2 : ezcArchive

in file archive.php, class constant ezcArchive::BZIP2
    BZIP2 compression format.

c

$centralHeaderPositions : ezcArchiveZip

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 : ezcArchiveZip

in file zip.php, variable ezcArchiveZip::$centralHeaders
    Stores the ezcArchiveCentralDirectoryHeader for each entry.

$completed : ezcArchive

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 : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::close()
    Closes the archive correctly.

close : ezcArchive

in file archive.php, method ezcArchive::close()
    Close the current archive.

createDefaultDirectory : ezcArchive

in file archive.php, method ezcArchive::createDefaultDirectory()
    Creates all the directories needed to create the file $file.

createDirectoryCallback : ezcArchiveCallback

in file callback.php, method ezcArchiveCallback::createDirectoryCallback()
    Callback that's called for every directory creation.

createFileCallback : ezcArchiveCallback

in file callback.php, method ezcArchiveCallback::createFileCallback()
    Callback that's called for every file creation.

createInstance : ezcArchive

in file archive.php, method ezcArchive::createInstance()
    Returns an instance of the archive with the given type.

createTarHeader : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::createTarHeader()
    Creates the a new tar header for this class.

createTarHeader : ezcArchiveGnuTar

in file gnu.php, method ezcArchiveGnuTar::createTarHeader()
    Creates the a new pax tar header for this class.

createTarHeader : ezcArchivePaxTar

in file pax.php, method ezcArchivePaxTar::createTarHeader()
    Creates the a new pax tar header for this class.

createTarHeader : ezcArchiveUstarTar

in file ustar.php, method ezcArchiveUstarTar::createTarHeader()
    Creates the a new ustar tar header for this class.

current : ezcArchive

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

e

$endRecord : ezcArchiveZip

in file zip.php, variable ezcArchiveZip::$endRecord
    Stores the ezcArchiveCentralDirectoryEndHeader.

$entries : ezcArchive

in file archive.php, variable ezcArchive::$entries
    Stores the entries read from the archive.

$entriesRead : ezcArchive

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 : ezcArchive

in file archive.php, method ezcArchive::extract()
    Extract entries from the archive to the target directory.

extractCurrent : ezcArchive

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.

f

$file : ezcArchive

in file archive.php, variable ezcArchive::$file
    Direct access to the archive file.

$fileNumber : ezcArchive

in file archive.php, variable ezcArchive::$fileNumber
    The entry or file number to which the iterator points.

$fileStructure : ezcArchiveEntry

in file entry.php, variable ezcArchiveEntry::$fileStructure
    Contains the file information.

g

gnu.php

procedural page gnu.php

getAccessTime : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getAccessTime()
    Returns the last access time as a timestamp.

getAlgorithm : ezcArchive

in file archive.php, method ezcArchive::getAlgorithm()
    Returns the algorithm that is used currently.

getAlgorithm : ezcArchiveGnuTar

in file gnu.php, method ezcArchiveGnuTar::getAlgorithm()
    Returns the value which specifies a TAR_GNU algorithm.

getAlgorithm : ezcArchiveZip

in file zip.php, method ezcArchiveZip::getAlgorithm()
    Returns the value which specifies a ZIP algorithm.

getAlgorithm : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::getAlgorithm()
    Returns the value which specifies a TAR_V7 algorithm.

getAlgorithm : ezcArchivePaxTar

in file pax.php, method ezcArchivePaxTar::getAlgorithm()
    Returns the value which specifies a TAR_PAX algorithm.

getAlgorithm : ezcArchiveUstarTar

in file ustar.php, method ezcArchiveUstarTar::getAlgorithm()
    Returns the value which specifies a TAR_USTAR algorithm.

getDevice : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getDevice()
    Returns the device.

getEntries : ezcArchive

in file archive.php, method ezcArchive::getEntries()
    Get the file entries from the archive.

getEntryFromFile : ezcArchiveEntry

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 : ezcArchiveZip

in file zip.php, method ezcArchiveZip::getFileData()
    Returns the file data of the given fileNumber.

getFileStructureFromFile : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getFileStructureFromFile()
    Create a file structure from a $file in the file system.

getGroupId : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getGroupId()
    Returns the group ID of the entry.

getInode : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getInode()
    Returns the inode.

getLink : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getLink()
    Returns the link with or without prefix.

getLinkType : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getLinkType()
    Returns an ezcArchiveEntry-type that corresponds to the ezcArchiveStatMode-type

getListing : ezcArchive

in file archive.php, method ezcArchive::getListing()
    Returns an array that lists the content of the archive.

getLocalHeader : ezcArchiveZip

in file zip.php, method ezcArchiveZip::getLocalHeader()
    Returns the local header of the specified file number.

getMajor : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getMajor()
    Returns the major device number.

getMinor : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getMinor()
    Returns the minor device number.

getModificationTime : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getModificationTime()
    Returns the modification time as a timestamp.

getPath : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getPath()
    Returns the complete path or path without the prefix.

getPermissions : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getPermissions()
    Returns a bit mask representing the permissions of this entry.

getPermissionsString : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getPermissionsString()
    Returns the permissions as a string.

getPrefix : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getPrefix()
    Returns the prefix.

getSize : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getSize()
    Returns the file size.

getTarInstance : ezcArchive

in file archive.php, method ezcArchive::getTarInstance()
    Open a tar instance.

getType : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getType()
    Returns type of the entry.

getTypeString : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getTypeString()
    Returns the type string for the current type of the entry.

getUserId : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::getUserId()
    Returns the user ID of the entry.

getZipInstance : ezcArchive

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 : ezcArchive

in file archive.php, class constant ezcArchive::GZIP
    Gnu ZIP compression format.

h

$hasNullBlocks : ezcArchiveV7Tar

in file v7.php, variable ezcArchiveV7Tar::$hasNullBlocks
    Specifies if the archive contains null blocks.

$headerPositions : ezcArchiveV7Tar

in file v7.php, variable ezcArchiveV7Tar::$headerPositions
    Stores the block number where the header starts.

$headers : ezcArchiveV7Tar

in file v7.php, variable ezcArchiveV7Tar::$headers
    Stores all the headers from the archive.

i

internal_exception.php

procedural page internal_exception.php

io.php

procedural page io.php

isDirectory : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::isDirectory()
    Returns true when this entry represents a directory.

isEmpty : ezcArchive

in file archive.php, method ezcArchive::isEmpty()
    Returns true if the current archive is empty, otherwise false.

isFile : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::isFile()
    Returns true when this entry represents a file.

isHardLink : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::isHardLink()
    Returns true when this entry represents a hard link.

isLink : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::isLink()
    Returns true when this entry represents a symbolic or a hard link.

isSymLink : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::isSymLink()
    Returns true when this entry represents a symbolic link.

isWritable : ezcArchiveZip

in file zip.php, method ezcArchiveZip::isWritable()
    Returns true if it is possible to write to the archive, otherwise false.

IS_BLOCK_DEVICE : ezcArchiveEntry

in file entry.php, class constant ezcArchiveEntry::IS_BLOCK_DEVICE
    Is a block device.

IS_CHARACTER_DEVICE : ezcArchiveEntry

in file entry.php, class constant ezcArchiveEntry::IS_CHARACTER_DEVICE
    Is a character device.

IS_DIRECTORY : ezcArchiveEntry

in file entry.php, class constant ezcArchiveEntry::IS_DIRECTORY
    Is a directory.

IS_FIFO : ezcArchiveEntry

in file entry.php, class constant ezcArchiveEntry::IS_FIFO
    Is a FIFO.

IS_FILE : ezcArchiveEntry

in file entry.php, class constant ezcArchiveEntry::IS_FILE
    Is a regular file.

IS_LINK : ezcArchiveEntry

in file entry.php, class constant ezcArchiveEntry::IS_LINK
    Is a hard link.

IS_RESERVED : ezcArchiveEntry

in file entry.php, class constant ezcArchiveEntry::IS_RESERVED
    Not used, is Tar specific?

IS_SYMBOLIC_LINK : ezcArchiveEntry

in file entry.php, class constant ezcArchiveEntry::IS_SYMBOLIC_LINK
    Is a symbolic link.

k

key : ezcArchive

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

l

$localHeaderPositions : ezcArchiveZip

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

$localHeaders : ezcArchiveZip

in file zip.php, variable ezcArchiveZip::$localHeaders
    Stores the ezcArchiveLocalFileHeader for each entry.

n

next : ezcArchive

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

o

$options : ezcArchive

in file archive.php, variable ezcArchive::$options
    Holds the options if passed to the open method.

open : ezcArchive

in file archive.php, method ezcArchive::open()
    Returns a new ezcArchive instance.

p

$prefix : ezcArchiveEntry

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

r

readCentralHeaders : ezcArchiveZip

in file zip.php, method ezcArchiveZip::readCentralHeaders()
    Reads the entire archive and creates all the entries.

readCurrentFromArchive : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::readCurrentFromArchive()
    Read the current entry from the archive.

removePrefixFromPath : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::removePrefixFromPath()
    Removes the prefix from the path and clears the prefix.

rewind : ezcArchive

in file archive.php, method ezcArchive::rewind()
    Rewinds the iterator to the first entry.

s

seek : ezcArchive

in file archive.php, method ezcArchive::seek()
    Search for the entry number.

setEndRecord : ezcArchiveZip

in file zip.php, method ezcArchiveZip::setEndRecord()
    Creates and sets a new ezcArchiveCentralDirectoryEndHeader.

setOptions : ezcArchive

in file archive.php, method ezcArchive::setOptions()
    This method associates a new $options object with this archive.

setPrefix : ezcArchiveEntry

in file entry.php, method ezcArchiveEntry::setPrefix()
    Sets the prefix.

t

TAR : ezcArchive

in file archive.php, class constant ezcArchive::TAR
    Normal tar archive.

TAR_GNU : ezcArchive

in file archive.php, class constant ezcArchive::TAR_GNU
    GNU tar archive.

TAR_PAX : ezcArchive

in file archive.php, class constant ezcArchive::TAR_PAX
    PAX tar archive.

TAR_USTAR : ezcArchive

in file archive.php, class constant ezcArchive::TAR_USTAR
    USTAR tar archive.

TAR_V7 : ezcArchive

in file archive.php, class constant ezcArchive::TAR_V7
    Tar version 7 archive.

truncate : ezcArchiveZip

in file zip.php, method ezcArchiveZip::truncate()
    Truncates the archive to $fileNumber of files.

truncate : ezcArchive

in file archive.php, method ezcArchive::truncate()
    Truncates the archive to $fileNumber of files.

truncate : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::truncate()
    Truncates the archive to $fileNumber of files.

u

unknown_type.php

procedural page unknown_type.php

ustar.php

procedural page ustar.php

v

value.php

procedural page value.php

v7.php

procedural page v7.php

valid : ezcArchive

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

w

writeCurrentDataToFile : ezcArchive

in file archive.php, method ezcArchive::writeCurrentDataToFile()
    Writes the file data from the current entry to the given file.

writeCurrentDataToFile : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::writeCurrentDataToFile()
    Writes the file data from the current entry to the given file.

writeCurrentDataToFile : ezcArchiveZip

in file zip.php, method ezcArchiveZip::writeCurrentDataToFile()
    Writes the file data from the current entry to the given file.

writeEnd : ezcArchiveV7Tar

in file v7.php, method ezcArchiveV7Tar::writeEnd()
    Writes the end of the archive.

writeFile : ezcArchiveZip

in file zip.php, method ezcArchiveZip::writeFile()
    Reads the file data from the archive and writes it the the $writeTo file.

z

zip.php

procedural page zip.php

ZIP : ezcArchive

in file archive.php, class constant ezcArchive::ZIP
    ZIP archive.