Class JArchiveZip

ZIP format adapter for the JArchive class

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

Deins125 <webmaster@atlant.ru> http://www.zend.com/codex.php?id=470&single=1

The ZIP compression date code is partially based on code from Peter Listiak <mlady@users.sourceforge.net>

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

JArchiveZip implements JArchiveExtractable

Package: Joomla\Platform\Archive
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Contributor: Chuck Hagenbuch <chuck@horde.org>
Contributor: Michael Slusarz <slusarz@horde.org>
Contributor: Michael Cochrane <mike@graftonhall.co.nz>
Located at joomla/archive/zip.php

Methods summary

`public boolean`	# `create( string $archive, array $files )` Create a ZIP compressed file from an array of file data. Create a ZIP compressed file from an array of file data. Parameters `$archive` `string` - $archive Path to save archive. `$files` `array` - $files Array of files to add to archive. Returns `boolean` - True if successful. Since 11.1
`public boolean`	# `extract( string $archive, string $destination, array $options = array() )` Extract a ZIP compressed file to a given path Extract a ZIP compressed file to a given path Parameters `$archive` `string` - $archive Path to ZIP archive to extract `$destination` `string` - $destination Path to extract archive into `$options` `array` - $options Extraction options [unused] Returns `boolean` - True if successful Throws `RuntimeException` Since 11.1 Implementation of `JArchiveExtractable::extract()`
`public static boolean`	# `isSupported( )` Tests whether this adapter can unpack files on this computer. Tests whether this adapter can unpack files on this computer. Returns `boolean` - True if supported Since 11.3 Implementation of `JArchiveExtractable::isSupported()`
`public static boolean`	# `hasNativeSupport( )` Method to determine if the server has native zip support for faster handling Method to determine if the server has native zip support for faster handling Returns `boolean` - True if php has native ZIP support Since 11.1
`public boolean`	# `checkZipData( string & $data )` Checks to see if the data is a valid ZIP file. Checks to see if the data is a valid ZIP file. Parameters `$data` `string` - &$data ZIP archive data buffer. Returns `boolean` - True if valid, false if invalid. Since 11.1
`protected mixed`	# `extractCustom( string $archive, string $destination )` Extract a ZIP compressed file to a given path using a php based algorithm that only requires zlib support Extract a ZIP compressed file to a given path using a php based algorithm that only requires zlib support Parameters `$archive` `string` - $archive Path to ZIP archive to extract. `$destination` `string` - $destination Path to extract archive into. Returns `mixed` - True if successful Throws `RuntimeException` Since 11.1
`protected boolean`	# `extractNative( string $archive, string $destination )` Extract a ZIP compressed file to a given path using native php api calls for speed Extract a ZIP compressed file to a given path using native php api calls for speed Parameters `$archive` `string` - $archive Path to ZIP archive to extract `$destination` `string` - $destination Path to extract archive into Returns `boolean` - True on success Throws `RuntimeException` Since 11.1
`protected integer`	# `_unix2DOSTime( integer $unixtime = null )` Converts a UNIX timestamp to a 4-byte DOS date and time format (date in high 2-bytes, time in low 2-bytes allowing magnitude comparison). Converts a UNIX timestamp to a 4-byte DOS date and time format (date in high 2-bytes, time in low 2-bytes allowing magnitude comparison). Parameters `$unixtime` `integer` - $unixtime The current UNIX timestamp. Returns `integer` - The current date in a 4-byte DOS format. Since 11.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JArchiveZip

Methods summary

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Implementation of

Returns

Since

Implementation of

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Magic methods summary