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

Class: ezcArchiveZip

The ezcArchiveZip class implements the Zip archive format. [source]

Implemented Interfaces

• Iterator (internal interface)

Parents

ezcArchive
   |
   --ezcArchiveZip

Inherited Constants

From ezcArchive:

ezcArchive::BZIP2	BZIP2 compression format.
ezcArchive::GZIP	Gnu ZIP compression format.
ezcArchive::TAR	Normal tar archive.
ezcArchive::TAR_GNU	GNU tar archive.
ezcArchive::TAR_PAX	PAX tar archive.
ezcArchive::TAR_USTAR	USTAR tar archive.
ezcArchive::TAR_V7	Tar version 7 archive.
ezcArchive::ZIP	ZIP archive.

Member Variables

protected array(int)	$centralHeaderPositions Stores the byte number where the central directory header starts (fileNumber is the index of the array).
protected array(ezcArchiveCentralDirectoryHeader)	$centralHeaders Stores the ezcArchiveCentralDirectoryHeader for each entry.
protected ezcArchiveCentralDirectoryEndHeader	$endRecord Stores the ezcArchiveCentralDirectoryEndHeader.
protected array(int)	$localHeaderPositions Stores the byte number where the local file header starts for each entry.
protected array(ezcArchiveLocalFileHeader)	$localHeaders Stores the ezcArchiveLocalFileHeader for each entry.

Inherited Member Variables

From ezcArchive:

protected	ezcArchive::$completed
protected	ezcArchive::$entries
protected	ezcArchive::$entriesRead
protected	ezcArchive::$file
protected	ezcArchive::$fileNumber

Method Summary

public ezcArchiveZip	__construct( $file ) Initializes the Zip archive and reads the entire archive.
public void	algorithmCanWrite( )
public void	appendToCurrent( $files, $prefix )
public void	getAlgorithm( )
public string	getFileData( $fileNumber ) Returns the file data of the given fileNumber.
protected void	readEntireArchive( ) Reads the entire archive and creates all the entries.
protected void	setEndRecord( ) Creates and sets a new ezcArchiveCentralDirectoryEndHeader.
public void	truncate( [$fileNumber = 0] )
protected void	writeCurrentDataToFile( $targetPath )
public void	writeFile( $fileNumber, $writeTo ) Reads the file data from the archive and writes it the the $writeTo file.

Inherited Methods

From ezcArchive :

public abstract bool	ezcArchive::algorithmCanWrite() Returns true if writing to the archive is implemented, otherwise false.
public void	ezcArchive::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.
public abstract void	ezcArchive::appendToCurrent() Appends a file to the archive after the current entry.
protected void	ezcArchive::createDefaultDirectory() Creates all the directories needed to create the file $file.
protected static ezcArchive	ezcArchive::createInstance() Returns an instance of the archive with the given type.
public ezcArchiveEntry	ezcArchive::current() Returns the current ezcArchiveEntry if it is valid, otherwise false is returned.
public void	ezcArchive::extract() Extract entries from the archive to the target directory.
public bool	ezcArchive::extractCurrent() Extract the current entry to which the iterator points.
public abstract int	ezcArchive::getAlgorithm() Returns the algorithm that is used currently.
public array(string)	ezcArchive::getListing() Returns an array that lists the content of the archive.
public static ezcArchive	ezcArchive::getTarInstance() Open a tar instance.
public static ezcArchive	ezcArchive::getZipInstance() Open a zip instance. This method is made public for testing purposes, and should not be used.
public bool	ezcArchive::isEmpty() Returns true if the current archive is empty, otherwise false.
public bool	ezcArchive::isWritable() Returns true if it is possible to write to the archive, otherwise false.
public int	ezcArchive::key() Returns the current key, entry number, if it is valid, otherwise false is returned.
public ezcArchiveEntry	ezcArchive::next() Forwards the iterator to the next entry.
public static ezcArchive	ezcArchive::open() Returns a new ezcArchive instance.
public void	ezcArchive::rewind() Rewinds the iterator to the first entry.
public bool	ezcArchive::seek() Search for the entry number.
public abstract void	ezcArchive::truncate() Truncate the archive to $fileNumber of files.
public bool	ezcArchive::valid() Returns true if the iterator points to a valid entry, otherwise false.
protected abstract void	ezcArchive::writeCurrentDataToFile() Writes the file data from the current entry to the given file.
public mixed	ezcArchive::__get() Returns the property $name.
public void	ezcArchive::__set() Sets the property $name to $value.
public string	ezcArchive::__toString() Returns a string which represents all the entries from the archive.

Methods

__construct

algorithmCanWrite

Redefinition of

Method	Description
ezcArchive::algorithmCanWrite()	Returns true if writing to the archive is implemented, otherwise false.

appendToCurrent

Parameters

Name	Type	Description
$files
$prefix

Redefinition of

Method	Description
ezcArchive::appendToCurrent()	Appends a file to the archive after the current entry.

getAlgorithm

Redefinition of

Method	Description
ezcArchive::getAlgorithm()	Returns the algorithm that is used currently.

getFileData

Parameters

Name	Type	Description
$fileNumber	int

readEntireArchive

setEndRecord

truncate

Parameters

Name	Type	Description
$fileNumber

Redefinition of

Method	Description
ezcArchive::truncate()	Truncate the archive to $fileNumber of files.

writeCurrentDataToFile

Parameters

Name	Type	Description
$targetPath

Redefinition of

Method	Description
ezcArchive::writeCurrentDataToFile()	Writes the file data from the current entry to the given file.

writeFile

Parameters

Name	Type	Description
$fileNumber	int
$writeTo	string

Throws

Class	Description
ezcArchiveChecksumException	if the checksum is invalid from the created file.