Référence de la classe JArchiveGzip

Graphe d'héritage de JArchiveGzip:

Fonctions membres publiques
	extract ($archive, $destination, array $options=array())
	_getFilePosition ()

Fonctions membres publiques statiques
static	isSupported ()

Fonctions membres protégées
	extractStream ($archive, $destination, $options=array())

Fonctions membres privées
	raiseWarning ($code, $msg)

Attributs privés
	$_flags = array('FTEXT' => 0x01, 'FHCRC' => 0x02, 'FEXTRA' => 0x04, 'FNAME' => 0x08, 'FCOMMENT' => 0x10)
	$_data = null

Description détaillée

Gzip format adapter for the JArchive class

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

Michael Slusarz slusa.nosp@m.rz@h.nosp@m.orde..nosp@m.org Michael Cochrane mike@.nosp@m.graf.nosp@m.tonha.nosp@m.ll.c.nosp@m.o.nz

Depuis

1.5

Obsolète:

4.0 use the Joomla class instead

Documentation des fonctions membres

_getFilePosition()

_getFilePosition

(

)

Get file data offset for archive

Renvoie

integer Data position marker for archive

Depuis

1.5

Exceptions

RuntimeException

Références $info, et $position.

extract()

extract	(		$archive,
			$destination,
		array	$options = array()
	)

Extract a Gzip compressed file to a given path

Paramètres

string	$archive	Path to ZIP archive to extract
string	$destination	Path to extract archive to
array	$options	Extraction options [unused]

Renvoie

boolean True if successful

Depuis

1.5

Exceptions

RuntimeException

Implémente JArchiveExtractable.

Références $buffer, $options, $position, et null.

extractStream()

extractStream (   $archive,   $destination,   $options = array()  )

protected

Method to extract archive using stream objects

Paramètres

string	$archive	Path to ZIP archive to extract
string	$destination	Path to extract archive to
array	$options	Extraction options [unused]

Renvoie

boolean True if successful

Depuis

3.6.0

Références $input, et $output.

isSupported()

static isSupported ( )

static

Tests whether this adapter can unpack files on this computer.

Renvoie

boolean True if supported

Depuis

2.5.0

Implémente JArchiveExtractable.

raiseWarning()

raiseWarning (   $code,   $msg  )

private

Temporary private method to isolate JError from the extract method This code should be removed when JError is removed.

Paramètres

int	$code	The application-internal error code for this error
string	$msg	The error message, which may also be shown the user if need be.

Renvoie

JException JException instance if JError class exists

Depuis

3.6.0

Exceptions

RuntimeException

if JError class does not exist

Références JError\raiseWarning().

Documentation des champs

$_data

$_data = null

private

$_flags

$_flags = array('FTEXT' => 0x01, 'FHCRC' => 0x02, 'FEXTRA' => 0x04, 'FNAME' => 0x08, 'FCOMMENT' => 0x10)

private

---

La documentation de cette classe a été générée à partir du fichier suivant :

• gzip.php