Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class JArchiveZip

Description
Description | Variables (details) | Methods (details)

ZIP format adapter for the JArchive class

The ZIP compression code is partially based on code from: Eric Mueller <[email protected]> http://www.zend.com/codex.php?id=535&single=1

Deins125 <[email protected]> http://www.zend.com/codex.php?id=470&single=1

The ZIP compression date code is partially based on code from Peter Listiak <[email protected]>

This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project <http://www.horde.org>

Located in /joomla/filesystem/archive/zip.php (line 43) 

Class JObject   (Subpackage Base)

Class JArchiveZip   (Subpackage FileSystem)
Variable Summary
Description | Variables (details) | Methods (details)
Variable string $_ctrlDirEnd
Variable string $_ctrlDirHeader
Variable string $_data
Variable string $_fileHeader
Variable array $_metadata
Variable array $_methods
Method Summary
Description | Variables (details) | Methods (details)
Method boolean checkZipData ( &$data, string $data)
Method boolean create (string $archive, array $files, [array $options = array ()])
Method boolean extract (string $archive, string $destination, [array $options = array ()])
Method boolean hasNativeSupport ()
Variables
Description | Variables (details) | Methods (details)
string $_ctrlDirEnd = "\x50\x4b\x05\x06\x00\x00\x00\x00" (line 70)

End of central directory record.

string $_ctrlDirHeader = "\x50\x4b\x01\x02" (line 64)

Beginning of central directory record.

string $_data = null (line 82)

ZIP file data buffer

string $_fileHeader = "\x50\x4b\x03\x04" (line 76)

Beginning of file contents.

array $_metadata = null (line 88)

ZIP file metadata array

array $_methods = array (
0x0 => 'None',
0x1 => 'Shrunk',
0x2 => 'Super Fast',
0x3 => 'Fast',
0x4 => 'Normal',
0x5 => 'Maximum',
0x6 => 'Imploded',
0x8 => 'Deflated'
) (line 49)

ZIP compression methods.

Methods
Description | Variables (details) Methods (details)
checkZipData (line 154)

Checks to see if the data is a valid ZIP file.

  • return: True if valid, false if invalid.
  • since: 1.5
  • access: public
boolean checkZipData ( &$data, string $data)
  • string $data: ZIP archive data buffer
  • &$data
create (line 102)

Create a ZIP compressed file from an array of file data.

  • return: True if successful
  • since: 1.5
  • access: public
  • todo: Finish Implementation
boolean create (string $archive, array $files, [array $options = array ()])
  • string $archive: Path to save archive
  • array $files: Array of files to add to archive
  • array $options: Compression options [unused]
extract (line 125)

Extract a ZIP compressed file to a given path

  • return: True if successful
  • since: 1.5
  • access: public
boolean extract (string $archive, string $destination, [array $options = array ()])
  • string $archive: Path to ZIP archive to extract
  • string $destination: Path to extract archive into
  • array $options: Extraction options [unused]
hasNativeSupport (line 141)

Method to determine if the server has native zip support for faster handling

  • return: True if php has native ZIP support
  • since: 1.5
  • access: public
boolean hasNativeSupport ()

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 21:33:38 +0000 by phpDocumentor 1.3.1